Reformats the setup and integrations docs under `docs/admin/setup` and `docs/admin/integrations` to one sentence per line, as the [docs style guide](https://github.com/coder/coder/blob/main/docs/.style/style-guide/formatting.md#one-sentence-per-line) requires. Hard-wrapped paragraphs are unwrapped and lines holding several sentences are split, so a later edit to one sentence shows up as a one-line diff. Apart from the exception below, only whitespace inside paragraphs and list items changes, and the rendered pages are the same. Comparing the changed files against `main` word for word, ignoring whitespace and blockquote `>` markers, finds differences only on the reworded lines. `git diff --word-diff` is easier to read than the line diff. 1 lines that already contained an em or en dash were reworded by hand, because `lint/emdash` treats every reflowed line as newly added. Each uses a parenthetical, a separate sentence, or a colon after a lead-in. Dashes on lines the reflow did not touch are left alone. Applied with an in-progress formatter, limited to pages listed in `docs/manifest.json` and excluding generated reference docs. This is one of a batch of PRs that split the docs by area (25 files changed, 380 insertions(+), 572 deletions(-)). --- 🤖 Built with AI assistance.
2.8 KiB
title
| title |
|---|
| DX PlatformX |
DX is a developer intelligence platform used by engineering leaders and platform engineers. Coder notifications can be transformed to PlatformX events, allowing platform engineers to measure activity and send pulse surveys to subsets of Coder users to understand their experience.
Requirements
You'll need:
- Coder v2.19+
- A PlatformX subscription from DX
- A platform to host the integration, such as:
- AWS Lambda
- Google Cloud Run
- Heroku
- Kubernetes
- Or any other platform that can run Python web applications
coder-platformx-events-middleware
Coder sends notifications via webhooks to coder-platformx-events-middleware, which processes and reformats the payload into a structure compatible with PlatformX by DX.
For more information about coder-platformx-events-middleware and how to integrate it with your Coder deployment and PlatformX events, refer to the coder-platformx-notifications repository.
Supported Notification Types
coder-platformx-events-middleware supports the following Coder notifications:
- Workspace Created
- Workspace Manually Updated
- User Account Created
- User Account Suspended
- User Account Activated
Environment Variables
The application expects the following environment variables when started.
For local development, create a .env file in the project root with the following variables.
A .env.sample file is included:
| Variable | Description | Example |
|---|---|---|
LOG_LEVEL |
Logging level (DEBUG, INFO, WARNING) |
INFO |
GETDX_API_KEY |
API key for PlatformX | your-api-key |
EVENTS_TRACKED |
Comma-separated list of tracked events | "Workspace Created,User Account Suspended" |
Logging
Logs are printed to the console and can be adjusted using the LOG_LEVEL variable.
The available levels are:
| Level | Description |
|---|---|
DEBUG |
Most verbose, useful for debugging |
INFO |
Standard logging for normal operation |
WARNING |
Logs only warnings and errors |
API Endpoints
GET /- Health check endpointPOST /- Webhook receiver
