API reference
Register webhook
Register a webhook endpoint and get a signing secret.
POST
/api/v1/webhooksStep-by-step guideStep 1 of 3
Select a stage to see what happens.
Your integration
Request readyIllustrative example
POST
/webhooks- Authorization
- Bearer ••••••••
- Accept
- application/json
Prepare the request
Use credentials for the selected environment and complete the required parameters.
Illustrative flow · no data is sent
How this endpoint works
Register a webhook endpoint. The response includes a per-endpoint secret used to sign deliveries.
Server-side authentication
Authentication guideRequest parameters
Expand a field to see its format and requirements.
urlstring
HTTPS endpoint that will receive the deliveries. If you omit it, we auto-generate a URL on our domain (managed inbox) and the response includes `managed: true`.
eventsstring[]Required
List of event names from the catalogue (see Webhooks & signing). `["*"]` subscribes to all of them.
descriptionstring
Free-form label (≤240 chars) — visible in the dashboard to distinguish multiple subscriptions.