Skip to content

docs: update PlatformX doc with steps from README #16406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 3, 2025
Merged

docs: update PlatformX doc with steps from README #16406

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e03f504
steps from readme to platformx doc
EdwardAngert Feb 3, 2025
1bd6af3
typo
EdwardAngert Feb 3, 2025
b9b432f
Update docs/admin/integrations/platformx.md
EdwardAngert Feb 3, 2025
788878c
use coder/doc for reference; point to repo for steps
EdwardAngert Feb 3, 2025
65f0d86
re-add requirements
EdwardAngert Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 48 additions & 6 deletions docs/admin/integrations/platformx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,59 @@ their experience.

You'll need:

- A running Coder v2.19+ deployment
- Coder v2.19+
- A PlatformX subscription from [DX](https://getdx.com/)
- A platform to host the integration (choose any of these):
- A platform to host the integration, such as:
- AWS Lambda
- Google Cloud Run
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added this based on the readme

This middleware is optimized for serverless environments such as Google Cloud Run and AWS Lambda.

- Heroku
- Kubernetes
- Or any other platform that can run Python web applications

## Getting Started
## coder-platformx-events-middleware

Refer to the instructions in the
Coder sends [notifications](../monitoring/notifications/index.md) via webhooks
to coder-platformx-events-middleware, which processes and reformats the payload
into a structure compatible with [PlatformX by DX](https://help.getdx.com/en/articles/7880779-getting-started).

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](https://github.com/coder/coder-platformx-notifications)
repository to deploy a lightweight web server to forward Coder Notifications to
PlatformX.
repository.

### Supported Notification Types

coder-platformx-events-middleware supports the following [Coder notifications](../monitoring/notifications/index.md):

- 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 endpoint
- `POST /` - Webhook receiver
Loading