Register a webhook endpoint
POST
/webhooksRequires scope: manage:webhooks
Request body
| Field | Type | Allowed values | Description |
|---|---|---|---|
urlrequired | string | any string | https only |
event_types | string[] | any string[] | Omit for all events |
Responses
| Status | Description |
|---|---|
201 | Created (secret shown once) |
400 | Invalid url / event types |
401 | Missing or invalid API key |
403 | Key lacks the required scope |
429 | Rate limit exceeded (see Retry-After) |
Is this page helpful?