Skip to main content
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.
The secret cannot be retrieved later. To replace it, use Rotate.

Request body

string
required
Target URL for deliveries. Must be https:// and publicly reachable: the platform sends a HEAD request at creation time and rejects the webhook if the endpoint cannot be reached. Any HTTP status counts as reachable; your endpoint does not need to accept HEAD.
string[]
default:["*"]
Event types delivered to this webhook. "*" subscribes to the session.status_updated firehose; granular session.* types are delivered only when listed explicitly. See the event catalog for supported types.
string
Optional label for the webhook (max 255 characters).

Examples

Response

Errors