Webhook Calls

REST endpoints for webhook calls. Bearer-auth required.

GET /api/webhook-calls

List inbound webhook calls.

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 calls to this workspace.
  • endpoint_id (optional): Filter calls to this inbound endpoint.
  • signature_status (optional): Shorthand: filter where signatureStatus equals this value.

Response

JSON
{
  "data": [
    {
      "id": "<...>",
      "workspaceId": "<...>",
      "endpointId": "<...>",
      "method": "<...>",
      "headers": "<...>",
      "contentType": "<...>",
      "body": "<...>",
      "bodyR2Key": "<...>",
      "bodySize": "<...>",
      "signatureStatus": "<...>",
      "sourceIp": "<...>",
      "receivedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

GET /api/webhook-calls/{id}

Get a webhook call by ID.

Path parameters

  • id (required): Webhook call to retrieve.

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "endpointId": "string",
  "method": "string",
  "headers": {},
  "contentType": "string",
  "body": "string",
  "bodyR2Key": "string",
  "bodySize": "integer",
  "signatureStatus": "unverified | passed | failed",
  "sourceIp": "string",
  "receivedAt": "string"
}

DELETE /api/webhook-calls/{id}

Delete a webhook call

Path parameters

  • id (required): Webhook call ID.

Response

JSON
{
  "id": "string",
  "workspaceId": "string",
  "endpointId": "string",
  "method": "string",
  "headers": {},
  "contentType": "string",
  "body": "string",
  "bodyR2Key": "string",
  "bodySize": "integer",
  "signatureStatus": "unverified | passed | failed",
  "sourceIp": "string",
  "receivedAt": "string"
}