API Docs

Webhooks

Receive real-time notifications when events occur in the system.

How webhooks work

When you have a webhook URL configured, the system will send an HTTP POST request to your endpoint for all events that occur. Each webhook call contains two keys:

  • event — a string identifying the event type
  • data — an object with event-specific data
{
    "event": "event_name",
    "data": {
        "somevalue": 42
    }
}

Response requirements

Your server must respond with an HTTP 200 status code. Any other status code is treated as a failed delivery attempt. Failed deliveries are retried automatically with increasing delays before being abandoned.

Available events