Skip to main content
POST
Create Webhook

Request

Headers

Requires an API key with the webhooks:write permission.

Body Parameters

string
required
HTTPS URL that will receive event deliveries. Must start with https://. URLs that resolve to private IP ranges are rejected (SSRF protection).
array
required
Array of event type strings to subscribe to. See Webhooks for the full list of 28 supported events.
string
Optional human-readable description (max 200 chars).
boolean
default:"true"
Whether the webhook should be active immediately. Set to false to register but pause deliveries.

Response

The secret field is returned only once — at creation time. Store it in a secure secret manager immediately. It cannot be retrieved later; if lost, delete and recreate the webhook to rotate.
object

Example Response

Errors