Create Webhook Subscription
Create a webhook subscription.
Requires the webhooks:write scope on the API key.
Authorizations
Bearer API key issued from Settings → Developers.
Body
Create Webhook Subscription payload
Name of the subscription.
1 - 255Endpoint that will receive POST deliveries.
1 - 2083Event types this subscription should receive.
1message.sent, message.opened, message.link_clicked, message.replied, invitation.sent, invitation.accepted, hot_lead.created, meeting.created, sequence.created, sequence.paused, sequence.resumed, sequence.stopped, sequence.completed, task.created, task.completed, task.skipped Free-form description.
1000Restrict deliveries to events from these sequence templates.
1Response
Successful Response
Unique identifier.
Name of the subscription.
Delivery URL events are POSTed to.
Free-form description.
Event types this subscription receives.
message.sent, message.opened, message.link_clicked, message.replied, invitation.sent, invitation.accepted, hot_lead.created, meeting.created, sequence.created, sequence.paused, sequence.resumed, sequence.stopped, sequence.completed, task.created, task.completed, task.skipped Sequence-template scope.
Lifecycle status.
ACTIVE, PAUSED, DISABLED Leading characters of the signing secret, safe to display.
When the subscription was created.
When the subscription last changed.
Signing secret. Returned ONLY in this response — store it now, it is never returned again.