List webhook delivery history.

curl --request GET \
  --url https://sandbox.api.byzantine.fi/v1/webhooks/deliveries \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>'

import requests

url = "https://sandbox.api.byzantine.fi/v1/webhooks/deliveries"

headers = {
    "X-Pubkey": "<x-pubkey>",
    "X-Timestamp": "<x-timestamp>",
    "X-Signature": "<x-signature>",
    "X-Pubkey, X-Timestamp, X-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Pubkey': '<x-pubkey>',
    'X-Timestamp': '<x-timestamp>',
    'X-Signature': '<x-signature>',
    'X-Pubkey, X-Timestamp, X-Signature': '<api-key>'
  }
};

fetch('https://sandbox.api.byzantine.fi/v1/webhooks/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "deliveries": [
    {
      "delivery": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "subscriptionId": "550e8400-e29b-41d4-a716-446655440000",
        "eventId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "pending",
        "attemptCount": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "nextAttemptAt": "2023-11-07T05:31:56Z",
        "terminalReason": "<string>",
        "lastResponseSummary": null
      },
      "event": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "eventType": "<string>",
        "sourceType": "<string>",
        "sourceId": "<string>",
        "payload": "<unknown>",
        "payloadVersion": 123,
        "sourceTransitionMetadata": "<unknown>",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "attempts": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "deliveryId": "550e8400-e29b-41d4-a716-446655440000",
          "attemptNumber": 123,
          "outcome": "succeeded",
          "signedAt": "2023-11-07T05:31:56Z",
          "signedTimestamp": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "signingKeyId": "550e8400-e29b-41d4-a716-446655440000",
          "statusCode": 123,
          "error": "<string>",
          "latencyMs": 123,
          "responseSummary": null,
          "actor": "<string>"
        }
      ]
    }
  ],
  "limit": 123,
  "offset": 123,
  "hasMore": true,
  "attemptsIncluded": true
}

GET

webhooks

deliveries

List webhook delivery history.

curl --request GET \
  --url https://sandbox.api.byzantine.fi/v1/webhooks/deliveries \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>'

import requests

url = "https://sandbox.api.byzantine.fi/v1/webhooks/deliveries"

headers = {
    "X-Pubkey": "<x-pubkey>",
    "X-Timestamp": "<x-timestamp>",
    "X-Signature": "<x-signature>",
    "X-Pubkey, X-Timestamp, X-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Pubkey': '<x-pubkey>',
    'X-Timestamp': '<x-timestamp>',
    'X-Signature': '<x-signature>',
    'X-Pubkey, X-Timestamp, X-Signature': '<api-key>'
  }
};

fetch('https://sandbox.api.byzantine.fi/v1/webhooks/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "deliveries": [
    {
      "delivery": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "subscriptionId": "550e8400-e29b-41d4-a716-446655440000",
        "eventId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "pending",
        "attemptCount": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "nextAttemptAt": "2023-11-07T05:31:56Z",
        "terminalReason": "<string>",
        "lastResponseSummary": null
      },
      "event": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "eventType": "<string>",
        "sourceType": "<string>",
        "sourceId": "<string>",
        "payload": "<unknown>",
        "payloadVersion": 123,
        "sourceTransitionMetadata": "<unknown>",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "attempts": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "deliveryId": "550e8400-e29b-41d4-a716-446655440000",
          "attemptNumber": 123,
          "outcome": "succeeded",
          "signedAt": "2023-11-07T05:31:56Z",
          "signedTimestamp": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "signingKeyId": "550e8400-e29b-41d4-a716-446655440000",
          "statusCode": 123,
          "error": "<string>",
          "latencyMs": 123,
          "responseSummary": null,
          "actor": "<string>"
        }
      ]
    }
  ],
  "limit": 123,
  "offset": 123,
  "hasMore": true,
  "attemptsIncluded": true
}

Authorizations

X-Pubkey, X-Timestamp, X-Signature

string

header

required

Headers

X-Pubkey

string

required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

X-Timestamp

string

required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

X-Signature

string

required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

Query Parameters

limit

integer<int64> | null

Page size for delivery history. Defaults to 100 and is capped at 250.

offset

integer<int64> | null

Number of delivery records to skip. Defaults to 0.

includeAttempts

boolean | null

Include delivery attempt records for each delivery. Defaults to true for backwards compatibility; set false for lighter list views.

subscriptionId

string<uuid> | null

Restrict to one webhook subscription. A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

eventId

string<uuid> | null

Restrict to one webhook event row. A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

eventType

string | null

Restrict to one public event type, e.g. customer.active or webhook.test.

status

enum<string> | null

Restrict to one delivery status, e.g. failed or terminal_failed. Durable webhook delivery lifecycle status stored as TEXT in Postgres.

Available options:

pending,

sending,

succeeded,

failed,

terminal_failed

Example:

"pending"

sourceType

string | null

Restrict to source type. Known values include bridge, sumsub, and customer_api; future sources are exact-match strings.

sourceId

string | null

Restrict to the durable event source id.

accountId

string<uuid> | null

Restrict to lifecycle events for an account id in the webhook payload. A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

providerEventId

string | null

Restrict to lifecycle events with this provider event id in the webhook payload.

Response

200 - application/json

Webhook delivery history

deliveries

object[]

required

Show child attributes

limit

integer<int64>

required

offset

integer<int64>

required

hasMore

boolean

required

attemptsIncluded

boolean

required

Send a signed test webhook.Retry a webhook delivery.

Integrator API

API endpoints

List webhook delivery history.

Authorizations

Headers

Query Parameters

Response