List deliveries

GET /api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries

List a webhook's deliveries

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "attempt": 1,
      "deliveredAt": "2023-11-07T05:31:56Z",
      "eventType": "treasury.payout.awaiting_approval",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "success": true,
      "webhookId": "<string>",
      "errorMessage": "<string>",
      "payload": "<unknown>",
      "redeliverAvailable": true,
      "redeliveryOf": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "statusCode": 1,
      "test": true
    }
  ],
  "nextCursor": "<string>",
  "retention": {
    "capacity": 1,
    "scope": "<string>"
  },
  "totalCount": 1
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

webhooks_manage · bearer_auth

webhooks_manage · api_key

Headers

X-Workspace-Id · string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId · string · required

Workspace ID

webhookId · string · required

Webhook ID

Query Parameters

limit · integer<int32>

Page size, default 20, clamped to 1–100

Required range: x >= 0

cursor · string

Opaque nextCursor from this webhook's delivery history

Response

200

application/json

Cursor page of webhook deliveries

Paginated webhook deliveries response.

items · object[] · required

Show child attributes

nextCursor · string | null · required

retention · object · required

Delivery logs are bounded and disappear when this server process restarts.

Show child attributes

totalCount · integer · required

Required range: x >= 0