Create a webhook
Webhooks
Create a webhook
Register a URL to receive signed event notifications.
POST
Create a webhook
Registers a webhook for your organization. The response includes the signing
secret. This is the only time it is returned, so store it securely.
Returns 201 with the created webhook object plus its secret.
Request body
Target URL for deliveries. Must be
https:// and publicly reachable; deliveries to private or internal hosts are skipped.Event types delivered to this webhook.
"*" subscribes to all current and future types. Supported types: session.status_updated.Optional label for the webhook (max 255 characters).
Examples
Response
Errors
| Status | Cause |
|---|---|
400 | Organization webhook limit reached (10). |
422 | Body failed validation: non-https URL, empty or unknown enabled_events. |