Sign in

v49

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

List platform webhook deliveries

Get a paginated list of platform webhook delivery attempts.

Filter by:

  • webhookId - Specific webhook
  • tenantId - Specific tenant
  • event - Specific event type
  • success - Successful (2xx) or failed deliveries
  • before/after - Time range (Unix timestamps)

Deliveries are returned in reverse chronological order.

get/platform/webhooks/deliveries

Query parameters

webhookIdstring

Filter by platform webhook ID

tenantIdstring

Filter by tenant ID

event'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError'

Filter by event type

successboolean

Filter by delivery success

beforeinteger

Only deliveries before this Unix timestamp

afterinteger

Only deliveries after this Unix timestamp

pageinteger

Page number (default 1)

perPageinteger

Items per page (default 30, max 100)

Response

List of platform webhook deliveries

successtrue required
pageinteger required

Current page number

perPageinteger required

Items per page

totalinteger required

Total number of deliveries matching the filter

totalPagesinteger required

Total number of pages

Example response

{
  "data": [
    {
      "id": "pwd_abc123def456",
      "webhookId": "pwh_abc123def456",
      "tenantId": "cm6abc123def456",
      "event": "MessageSent",
      "statusCode": 200,
      "success": true,
      "attempt": 1,
      "timestamp": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 150,
  "totalPages": 5,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}