Webhook endpoints
Manage the HTTPS receivers for your Developer API events.
Scale · Dashboard sessionList endpoints
GET /api/v1/developer/webhooks
Authorization: Bearer DASHBOARD_SESSION_TOKENReturns { webhooks: [...] } with public endpoint metadata: id, name, url, status, created_at and last_delivery_at. Signing secrets are excluded.
Register an endpoint
POST /api/v1/developer/webhooks
Authorization: Bearer DASHBOARD_SESSION_TOKEN
Content-Type: application/json
{
"name": "Support sync",
"url": "https://example.com/pingback/events"
}| Field | Requirement |
|---|---|
| name | Optional, 1–80 characters; defaults to Pingback integration |
| url | Required public HTTPS URL, maximum 2,048 characters |
| Restricted URLs | No localhost, private networks, credentials or fragments |
{
"webhook": {
"id": "wh_example",
"name": "Support sync",
"url": "https://example.com/pingback/events",
"status": "active"
},
"secret": "whsec_YOUR_ONE_TIME_SECRET",
"warning": "Store this secret securely. It will not be shown again."
}Disable an endpoint
DELETE /api/v1/developer/webhooks/{webhook_id}
Authorization: Bearer DASHBOARD_SESSION_TOKENReturns { status: 'disabled', id }. New deliveries stop; existing delivery records remain available. Requests to webhook receivers do not follow redirects.