Skip to main content
GET
/
platform
/
webhooks
/
deliveries
List platform webhook deliveries
curl --request GET \
  --url https://api.arkhq.io/v1/platform/webhooks/deliveries \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "pwd_abc123def456",
      "webhookId": "pwh_abc123def456",
      "tenantId": "cm6abc123def456",
      "event": "MessageSent",
      "url": "<string>",
      "statusCode": 200,
      "success": true,
      "attempt": 1,
      "willRetry": false,
      "timestamp": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 150,
  "totalPages": 5,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Query Parameters

webhookId
string

Filter by platform webhook ID

tenantId
string

Filter by tenant ID

event
enum<string>

Filter by event type

Available options:
MessageSent,
MessageDelayed,
MessageDeliveryFailed,
MessageHeld,
MessageBounced,
MessageLinkClicked,
MessageLoaded,
DomainDNSError
success
boolean

Filter by delivery success

before
integer

Only deliveries before this Unix timestamp

after
integer

Only deliveries after this Unix timestamp

page
integer
default:1

Page number (default 1)

perPage
integer
default:30

Items per page (default 30, max 100)

Required range: x <= 100

Response

List of platform webhook deliveries

Paginated list of platform webhook delivery attempts

success
boolean
required
data
object[]
required
page
integer
required

Current page number

Example:

1

perPage
integer
required

Items per page

Example:

30

total
integer
required

Total number of deliveries matching the filter

Example:

150

totalPages
integer
required

Total number of pages

Example:

5

meta
object
required