Webhook Delivery Attempts

REST endpoints for webhook delivery attempts. Bearer-auth required.

GET /api/webhook-delivery-attempts

List webhook delivery attempts.

Query parameters

  • delivery_id (required): Webhook delivery to list attempts for.

Response

JSON
{
  "data": [
    {
      "id": "<...>",
      "workspaceId": "<...>",
      "deliveryId": "<...>",
      "attemptNumber": "<...>",
      "kind": "<...>",
      "url": "<...>",
      "statusCode": "<...>",
      "error": "<...>",
      "durationMs": "<...>",
      "responseHeaders": "<...>",
      "responseBodyPreview": "<...>",
      "startedAt": "<...>",
      "completedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

GET /api/webhook-delivery-attempts/{id}

Get a webhook delivery attempt by ID.

Path parameters

  • id (required): Webhook delivery attempt to retrieve.

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "deliveryId": "string",
  "attemptNumber": "integer",
  "kind": "initial | auto_retry | manual_retry",
  "url": "string",
  "statusCode": "integer",
  "error": "string",
  "durationMs": "integer",
  "responseHeaders": {},
  "responseBodyPreview": "string",
  "startedAt": "string",
  "completedAt": "string"
}