webhooks
Create Webhook Subscription
Create a webhook subscription.
Requires the webhooks:write scope on the API key.
post/v1/webhooks
Request body
namestring required
Name of the subscription.
urlstring uri required
Endpoint that will receive POST deliveries.
descriptionstring nullable
Free-form description.
event_typesOutboundWebhookEventType[] required
Event types this subscription should receive.
sequence_template_idsstring[] nullable
Restrict deliveries to events from these sequence templates.
Response
Successful Response
idstring uuid required
Unique identifier.
namestring required
Name of the subscription.
urlstring required
Delivery URL events are POSTed to.
descriptionstring nullable required
Free-form description.
event_typesOutboundWebhookEventType[] required
Event types this subscription receives.
sequence_template_idsstring[] nullable required
Sequence-template scope.
status'ACTIVE' | 'PAUSED' | 'DISABLED' required
secret_prefixstring required
Leading characters of the signing secret, safe to display.
created_atstring date-time required
When the subscription was created.
updated_atstring date-time required
When the subscription last changed.
secretstring required
Signing secret. Returned ONLY in this response — store it now, it is never returned again.