Sign in
Webhooks

Create outbound webhook

Creates an outbound webhook endpoint. The signing secret is returned only in this response.

post/webhooks

Request body

namestring required
urlstring uri required
eventsOutboundWebhookEventType[]

Omit to subscribe to default email lifecycle events plus subscriber.invalid and subscriber.unsubscribed. Add email.opened, email.clicked, subscriber.updated, sequence.finished, and sequence.failed explicitly for engagement, profile sync, or sequence lifecycle events.

Example request

{
  "name": "Production webhook",
  "url": "https://example.com/sequenzy/webhooks"
}

Response

Created

successboolean

Example response

{
  "webhook": {
    "id": "webhook_abc123",
    "name": "Production webhook",
    "url": "https://example.com/sequenzy/webhooks",
    "signingSecret": "whsec_...",
    "signingSecrets": [
      {
        "id": "sec_abc123",
        "prefix": "whsec_abcd12"
      }
    ]
  }
}

Changes