ARarkhq-io
Webhooks

List webhook deliveries

Changed on

Get a paginated list of delivery attempts for a specific webhook.

Use this to:

  • Monitor webhook health and delivery success rate
  • Debug failed deliveries
  • Find specific events to replay

Filtering:

  • Filter by success/failure to find problematic deliveries
  • Filter by event type to find specific events
  • Filter by time range for debugging recent issues

Retry behavior: Failed deliveries are automatically retried with exponential backoff over ~3 days. Check willRetry to see if more attempts are scheduled.

get/tenants/{tenantId}/webhooks/{webhookId}/deliveries

Request

Query parameters

pageinteger

Page number (default 1)

perPageinteger

Items per page (default 30, max 100)

successboolean

Filter by delivery success (true = 2xx response, false = non-2xx or error)

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

Filter by event type

beforeinteger

Only deliveries before this Unix timestamp

afterinteger

Only deliveries after this Unix timestamp

Response

List of webhook deliveries

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": "whr_abc123def456",
      "webhookId": "456",
      "event": "MessageSent",
      "url": "https://myapp.com/webhooks/email",
      "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"
  }
}

Changes