Skip to main content

Method

Parameters

*CreateWebhookRequest
required
The webhook creation parameters
string
required
The URL endpoint that will receive webhook events
[]string
required
Array of event types to subscribe to. Available events:
  • email.sent
  • email.delivered
  • email.delivery_delayed
  • email.complained
  • email.bounced
  • email.opened
  • email.clicked
  • email.received
  • email.failed
  • contact.created
  • contact.updated
  • contact.deleted
  • domain.created
  • domain.updated
  • domain.deleted

Response

string
Always "webhook"
string
The unique identifier of the created webhook
string
The signing secret for verifying webhook payloads. Store this securely - it’s only shown once.

Example