Sign in

v49

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

Create a platform webhook

Create a platform webhook to receive email event notifications from all tenants.

Platform webhooks receive events from all tenants in your organization. Each webhook payload includes a tenant_id field to identify which tenant the event belongs to.

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

Webhook payload includes:

  • event - The event type
  • tenant_id - The tenant that sent the email
  • timestamp - Unix timestamp of the event
  • payload - Event-specific data (message details, status, etc.)
post/platform/webhooks

Request body

namestring required

Display name for the webhook

urlstring uri required

Webhook endpoint URL (must be HTTPS)

eventsstring[]

Events to subscribe to. Empty array means all events.

Example request

{
  "name": "Central Event Processor",
  "url": "https://myplatform.com/webhooks/email-events",
  "events": [
    "MessageSent",
    "MessageDeliveryFailed",
    "MessageBounced"
  ]
}

Response

Platform webhook created

successtrue required

Example response

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