Skip to main content
POST
Create a subscription
Creates a webhook subscription that delivers events to the specified URL. The full secret is only returned in this response.

Request body

string
required
The URL to receive webhook POST requests. Must be a valid URL (max 2048 characters).
string
required
The resource name to subscribe to. Must match a registered resource.
array
required
Array of trigger events to listen for. Must be a subset of the resource’s supported triggers: on_create, on_update, on_delete.

Request

Response

Returns the created subscription with a 201 Created status. The secret field contains the full webhook secret. Example response:
The secret is only returned in full in this response. Store it securely — you need it to verify webhook signatures. Subsequent requests show only a masked version.

Errors