https://github.com/coder/coder-platformx-notifications
Transform Coder webhooks to PlatformX events
https://github.com/coder/coder-platformx-notifications
Last synced: 7 months ago
JSON representation
Transform Coder webhooks to PlatformX events
- Host: GitHub
- URL: https://github.com/coder/coder-platformx-notifications
- Owner: coder
- License: mit
- Created: 2025-01-27T00:05:26.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-10T08:40:14.000Z (7 months ago)
- Last Synced: 2025-06-13T14:06:40.471Z (7 months ago)
- Language: Python
- Homepage:
- Size: 167 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coder PlatformX Events Middleware
## Overview
This sample middleware transforms Coder notification payloads into PlatformX-compatible payloads and forwards them to [PlatformX by DX](https://getdx.com/platformx) for tracking. It is optimized for serverless platforms such as AWS Lambda and Google Cloud Run but may require modifications to fit your organization's needs.
> [!NOTE]
> This repository is a sample implementation. Adaptations in other languages and frameworks are possible.
## How It Works
Coder sends [notifications](https://coder.com/docs/admin/monitoring/notifications) via webhooks to this middleware, which processes and reformats the payload into a structure compatible with [PlatformX by DX](https://help.getdx.com/en/articles/7880779-getting-started). The transformed payload is then forwarded to PlatformX for further processing and analysis.
```mermaid
graph LR;
Coder[Coder Server] -->|Webhook Notification| Middleware[coder-platformx-notifications];
Middleware -->|Transformed Payload| PlatformX[PlatformX API];
```
## Supported Notification Types
This middleware supports the following [Coder notifications](https://coder.com/docs/admin/monitoring/notifications):
- Workspace Created
- Workspace Manually Updated
- User Account Created
- User Account Suspended
- User Account Activated
## Deployment
This middleware is optimized for serverless environments such as Google Cloud Run and AWS Lambda. If using Docker as a fallback:
```sh
git clone
cd
docker build -t coder-platformx-events-middleware .
docker run -p 8080:8080 --env-file .env coder-platformx-events-middleware
```
## Environment Variables
The application expects the following environment variables when started. For local development, create a `.env` file in the project root and set 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 |
## Usage with Coder Server
You must be running Coder v2.19+. To configure Coder to send notifications to this middleware, set the following environment variables for your Coder server:
```sh
export CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT=
export CODER_NOTIFICATIONS_METHOD=webhook # Optional, as multiple methods are supported
```
Replace `` with the actual URL where this middleware is hosted.
## API Endpoints
- `GET /` - Health check endpoint
- `POST /` - Webhook receiver
## 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 |
## Development
This application was written in Python 3.11.x.
1. Clone the repository:
```sh
git clone
cd
```
2. Install dependencies:
```sh
pip install -r requirements.txt
```
3. Start the Flask development server:
```sh
python3 main.py
```