Webhooks

Create outbound webhook

Changed on

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

post/webhooks

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/webhooks
  • Auth
    HTTP bearer

Request body

namestring required
urlstring uri required
eventsOutboundWebhookEventType[]

Omit to subscribe to default email and SMS lifecycle events plus subscriber.invalid, subscriber.created, and subscriber.unsubscribed. Add campaign.sent, email.opened, email.clicked, email.replied, email.received, subscriber.updated, subscriber.list_subscribed, subscriber.list_unsubscribed, sequence.finished, and sequence.failed explicitly for aggregate campaign completion, engagement, inbound reply, new inbox mail, profile sync, per-list consent sync, or sequence lifecycle events. SMS events (sms.sent, sms.delivered, sms.failed, sms.opted_out) are included in the defaults.

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

  • db3873ca3d4dRevision changes
    • warning

      added the new email.received enum value to the // response property for the response status

    • info

      added the new email.received enum value to the request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 11b6d27ba1deRevision changes
    • warning

      added the new campaign.sent enum value to the // response property for the response status

    • info

      added the new campaign.sent enum value to the request property /