Endpoint
Overview
This endpoint allows you to create a new event record tied to a project.Optionally, you can trigger a Discord webhook notification at the same time.
Authentication
This endpoint requires an API key. You can retrieve an API key from your dashboard. Include it in theX-API-KEY header:
Request Body
Send a JSON payload with the following structure:| Field | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | ID of the project to associate the event with. |
eventType | string | Yes | Type or category of the event. |
description | string | No | Optional human-readable description. |
payload | object | No | Arbitrary JSON payload for additional data. |
color | integer | No | Hex integer color (e.g., 16777215 for white). |
discordWebhook | object | No | Optional Discord webhook to notify. |
discordWebhook.url | string | Yes if discordWebhook | Must be a valid HTTPS Discord webhook URL. |
discordWebhook.title | string | Yes if discordWebhook | Title of the Discord message. |
discordWebhook.description | string | No | Description in the Discord embed. |
discordWebhook.color | integer | No | Override color for the Discord embed. |
Responses
β 200 OK
Event created successfully:β οΈ 400 Bad Request
If required fields are missing or the Discord URL is invalid:π 401 Unauthorized
If authentication fails:π« 403 Forbidden
If the project does not belong to the authenticated user:π₯ 500 Internal Server Error
For unexpected server errors:Examples
CURL
Python (requests)
JavaScript (fetch)
Notes
- This endpoint enforces ownership checks, meaning you can only create events for projects tied to your API key.
- Always ensure your
discordWebhook.urlis a valid HTTPS Discord webhook URL to avoid SSRF rejection.