WebhookCreateRequest

urlstring<uri>required

The URL to receive webhook events.

eventsWebhookEventType[]required

Event types to subscribe to.

Possible values: [email.sent, email.delivered, email.bounced, email.opened, email.clicked, email.complained, email.failed, email.delayed, email.cancelled, email.received, domain.verified, domain.verification_failed, tracking_domain.verified, tracking_domain.verification_failed, campaign.started, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.auto_paused, contact.status_changed, contact.import_completed, suppression.created, suppression.removed]

domain_idsstring<uuid>[]

Restrict this endpoint to the listed domains. Empty means every domain in the workspace. Only email.* and domain./tracking_domain. events carry a domain, so an endpoint subscribed to a campaign., contact. or suppression.* event must leave this empty.

descriptionstring

Optional description of the webhook endpoint.

secretstring

Signing secret. Auto-generated if omitted.

WebhookCreateRequest

{
  "url": "string",
  "events": [
    "email.sent"
  ],
  "domain_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "description": "string",
  "secret": "string"
}