Webhooks
Receive real-time notifications when export jobs are created, completed, or fail via HTTPS webhooks with HMAC-SHA256 signature verification.
premium business
The Webhook Object
| Field | Type | Description |
|---|---|---|
uuid | string | Unique webhook identifier |
url | string | HTTPS endpoint URL |
events | array | Event types to receive |
status | integer | 0=disabled, 1=enabled, 2=suspended |
enabled | boolean | Whether webhook is active |
isSuspended | boolean | Auto-suspended after 30 consecutive delivery failures |
lastEventAt | datetime | Last event delivery time |
webhookEventsCount | integer | Total events delivered |
createdAt | datetime | When the webhook was created |
Event Types
| Event | Triggered When |
|---|---|
export.created | A new export job starts processing |
export.finished | An export completes successfully |
export.failed | An export fails |
export.requeued | An export is requeued for retry |
Suspended Status
A webhook is automatically suspended (status=2) after 30 consecutive delivery failures. While suspended, no further events are delivered to that endpoint.
Reactivating a suspended webhook
To reactivate a suspended webhook, first fix the issue with your endpoint, then use the toggle endpoint to re-enable it. The failure counter resets once the webhook is successfully re-enabled.
Limits
| Feature | Premium | Business |
|---|---|---|
| Max webhooks | 1 | 10 |