Sign in

v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Webhooks

Create a webhook

Create a webhook endpoint to receive email event notifications for a tenant.

Available events:

  • MessageSent - Email accepted by recipient server
  • MessageDeliveryFailed - Delivery permanently failed
  • MessageDelayed - Delivery temporarily failed, will retry
  • MessageBounced - Email bounced
  • MessageHeld - Email held for review
  • MessageLinkClicked - Recipient clicked a link
  • MessageLoaded - Recipient opened the email
  • DomainDNSError - Domain DNS issue detected
post/tenants/{tenantId}/webhooks

Path parameters

tenantIdstring required

The tenant ID

Request body

namestring required

Webhook name for identification

urlstring uri required

HTTPS endpoint URL

eventsstring[] nullable

Events to subscribe to (accepts null):

  • MessageSent - Email successfully delivered to recipient's server
  • MessageDelayed - Temporary delivery failure, will retry
  • MessageDeliveryFailed - Permanent delivery failure
  • MessageHeld - Email held for manual review
  • MessageBounced - Email bounced back
  • MessageLinkClicked - Recipient clicked a tracked link
  • MessageLoaded - Recipient opened the email (tracking pixel loaded)
  • DomainDNSError - DNS configuration issue detected
allEventsboolean nullable

Subscribe to all events (ignores events array, accepts null)

enabledboolean nullable

Whether the webhook is enabled (accepts null)

Response

Webhook created

successtrue required

Example response

{
  "data": {
    "id": "456"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}