Webhook Deliveries

REST endpoints for webhook deliveries. Bearer-auth required.

GET /api/webhook-deliveries

List webhook deliveries.

Query parameters

limit (optional): Page size (1–100, default 100).
after (optional): Keyset cursor — return the page after this row (next page).
before (optional): Keyset cursor — return the page before this row (prev page).
ids (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
filter (optional): Nested filter expression (<Entity>Filter): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
orderBy (optional): Multi-key sort (<Entity>OrderBy[]): array of { field: direction } applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
workspace_id (optional): Filter deliveries to this workspace.
subscription_id (optional): Filter deliveries to this outbound subscription.
status (optional): Filter by lifecycle status.
source_event_id (optional): Shorthand: filter where sourceEventId equals this value.

Response

JSON

{
  "data": [
    {
      "id": "<...>",
      "workspaceId": "<...>",
      "subscriptionId": "<...>",
      "sourceEventId": "<...>",
      "eventType": "<...>",
      "payload": "<...>",
      "status": "<...>",
      "attemptCount": "<...>",
      "maxAttempts": "<...>",
      "nextRetryAt": "<...>",
      "createdAt": "<...>",
      "updatedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

GET /api/webhook-deliveries/{id}

Get a webhook delivery by ID.

Path parameters

id (required): Webhook delivery to retrieve.

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "subscriptionId": "string",
  "sourceEventId": "string",
  "eventType": "string",
  "payload": {},
  "status": "pending | retrying | completed | failed",
  "attemptCount": "integer",
  "maxAttempts": "integer",
  "nextRetryAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

DELETE /api/webhook-deliveries/{id}

Cancel a retrying delivery

Path parameters

id (required): Webhook delivery ID.

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "subscriptionId": "string",
  "sourceEventId": "string",
  "eventType": "string",
  "payload": {},
  "status": "pending | retrying | completed | failed",
  "attemptCount": "integer",
  "maxAttempts": "integer",
  "nextRetryAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

POST /api/webhook-deliveries/{id}/retry

Manually retry a delivery

Resets the delivery to a clean slate and immediately dispatches the initial attempt. Returns the row in its reset state; clients refetch to see the attempt result.

Path parameters

id (required): Webhook delivery ID.

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "subscriptionId": "string",
  "sourceEventId": "string",
  "eventType": "string",
  "payload": {},
  "status": "pending | retrying | completed | failed",
  "attemptCount": "integer",
  "maxAttempts": "integer",
  "nextRetryAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}