Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7bda04d

Browse files
authored
docs: update PlatformX doc with steps from README (#16406)
copied and reformatted the steps from the https://github.com/coder/coder-platformx-notifications README to include them as an example in the Coder docs [preview](https://coder.com/docs/@ea-dx-integration/admin/integrations/platformx) --------- Co-authored-by: EdwardAngert <[email protected]>
1 parent c0be21a commit 7bda04d

File tree

1 file changed

+48
-6
lines changed

1 file changed

+48
-6
lines changed

docs/admin/integrations/platformx.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,59 @@ their experience.
1212

1313
You'll need:
1414

15-
- A running Coder v2.19+ deployment
15+
- Coder v2.19+
1616
- A PlatformX subscription from [DX](https://getdx.com/)
17-
- A platform to host the integration (choose any of these):
17+
- A platform to host the integration, such as:
1818
- AWS Lambda
19+
- Google Cloud Run
1920
- Heroku
2021
- Kubernetes
2122
- Or any other platform that can run Python web applications
2223

23-
## Getting Started
24+
## coder-platformx-events-middleware
2425

25-
Refer to the instructions in the
26+
Coder sends [notifications](../monitoring/notifications/index.md) via webhooks
27+
to coder-platformx-events-middleware, which processes and reformats the payload
28+
into a structure compatible with [PlatformX by DX](https://help.getdx.com/en/articles/7880779-getting-started).
29+
30+
For more information about coder-platformx-events-middleware and how to
31+
integrate it with your Coder deployment and PlatformX events, refer to the
2632
[coder-platformx-notifications](https://github.com/coder/coder-platformx-notifications)
27-
repository to deploy a lightweight web server to forward Coder Notifications to
28-
PlatformX.
33+
repository.
34+
35+
### Supported Notification Types
36+
37+
coder-platformx-events-middleware supports the following [Coder notifications](../monitoring/notifications/index.md):
38+
39+
- Workspace Created
40+
- Workspace Manually Updated
41+
- User Account Created
42+
- User Account Suspended
43+
- User Account Activated
44+
45+
### Environment Variables
46+
47+
The application expects the following environment variables when started.
48+
For local development, create a `.env` file in the project root with the following variables.
49+
A `.env.sample` file is included:
50+
51+
| Variable | Description | Example |
52+
|------------------|--------------------------------------------|----------------------------------------------|
53+
| `LOG_LEVEL` | Logging level (`DEBUG`, `INFO`, `WARNING`) | `INFO` |
54+
| `GETDX_API_KEY` | API key for PlatformX | `your-api-key` |
55+
| `EVENTS_TRACKED` | Comma-separated list of tracked events | `"Workspace Created,User Account Suspended"` |
56+
57+
### Logging
58+
59+
Logs are printed to the console and can be adjusted using the `LOG_LEVEL` variable. The available levels are:
60+
61+
| Level | Description |
62+
|-----------|---------------------------------------|
63+
| `DEBUG` | Most verbose, useful for debugging |
64+
| `INFO` | Standard logging for normal operation |
65+
| `WARNING` | Logs only warnings and errors |
66+
67+
### API Endpoints
68+
69+
- `GET /` - Health check endpoint
70+
- `POST /` - Webhook receiver

0 commit comments

Comments
 (0)