API Referencev1
Webhooks API
Manage the endpoints that receive Connect events, send test events, change signing secrets and resend deliveries.
Updated 10 Oct 2026
On this page
All paths start with /api/console/connect/event-webhooks and need a session token and the workspace header. Reading is open to workspace members; changes need the webhooks.manage permission (owners, admins and developers) and otherwise return 403.
| Method | Path | Body and notes |
|---|---|---|
GET | /catalogue | Every event, grouped, with a plain-English label, description and sample payload |
GET | / | The workspace's endpoints |
POST | / | {name, url, mode: test or live, eventTypes[]} (1–30 events). Returns the endpoint and its secret, shown once. |
PATCH | /:endpointId | {name?, url?, status?: active or disabled, eventTypes?} |
DELETE | /:endpointId | Turns the endpoint off. Returns {id, status: "disabled"}. |
POST | /:endpointId/secret/rotate | Returns a new secret, shown once. The old secret stops working immediately. |
POST | /:endpointId/test | Sends a sandbox.test event and returns the delivery |
GET | /:endpointId/deliveries?status= | The 100 most recent deliveries, newest first. status is optional. |
POST | /:endpointId/deliveries/:deliveryId/resend | Sends the same event again and returns the new delivery |
Endpoint fields
| Field | Notes |
|---|---|
name | 1–120 characters |
url | HTTPS only |
mode | test (test-mode activity) or live (live activity) |
eventTypes | Event types from the catalogue |
status | active or disabled |
healthStatus, consecutiveFailures, lastSuccessAt, lastFailureAt | Health: unknown, healthy or degraded |
secretPrefix, secretLast4 | Identify the current secret without revealing it |
Delivery fields
| Field | Notes |
|---|---|
id, eventId, eventType, mode | Identity |
eventLabel, statusLabel | Plain-English event name and result, for example "Waiting to retry" |
status | queued, processing, retry_scheduled, delivered, failed, dead_lettered, cancelled or policy_denied |
attempt, maxAttempts, nextAttemptAt | Retry state |
firstAttemptAt, completedAt | Timing |
statusCode, durationMs, errorSummary | The latest response |
payload | Exactly what was sent |
attempts[] | Every try, with its result, response code, duration and error summary |
canResend | Whether the delivery can be sent again |
For the event list, message format, signature check and retry rules, see Webhooks.