Webhook Endpoints

REST endpoints for webhook endpoints. Bearer-auth required.

GET /api/webhook-endpoints

List webhook endpoints with pagination.

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 endpoints to this workspace.
include_deleted (optional): Soft-deleted endpoint visibility. false (default) — active rows only. true — active plus soft-deleted. only — soft-deleted only.
name (optional): Case-insensitive substring match on name.
enabled (optional): Shorthand: filter where enabled equals this value.
created_by (optional): Shorthand: filter where createdBy equals this value.

Response

JSON

{
  "data": [
    {
      "id": "<...>",
      "workspaceId": "<...>",
      "name": "<...>",
      "signatureHeader": "<...>",
      "signatureAlgo": "<...>",
      "enabled": "<...>",
      "createdBy": "<...>",
      "createdAt": "<...>",
      "updatedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

POST /api/webhook-endpoints

Create a webhook endpoint

Request body

JSON

{
  "workspaceId": "string",
  "name": "string",
  "secret?": "string",
  "signatureHeader?": "string",
  "signatureAlgo?": "hmac-sha256 | hmac-sha1"
}

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "signatureHeader": "string",
  "signatureAlgo": "string",
  "enabled": "boolean",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

GET /api/webhook-endpoints/{id}

Get a single webhook endpoint by ID.

Path parameters

id (required): Webhook endpoint to retrieve.

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "signatureHeader": "string",
  "signatureAlgo": "string",
  "enabled": "boolean",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

PATCH /api/webhook-endpoints/{id}

Update a webhook endpoint

Path parameters

id (required): The webhook endpoint's prefixed ID.

Request body

JSON

{
  "name?": "string",
  "secret?": "string",
  "signatureHeader?": "string",
  "signatureAlgo?": "hmac-sha256 | hmac-sha1 | ",
  "enabled?": "boolean"
}

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "signatureHeader": "string",
  "signatureAlgo": "string",
  "enabled": "boolean",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

DELETE /api/webhook-endpoints/{id}

Soft-delete a webhook endpoint.

Path parameters

id (required): Webhook endpoint to soft-delete.

Response

JSON

{
  "success": "boolean"
}

DELETE /api/webhook-endpoints/{id}/purge

Permanently delete a soft-deleted webhook endpoint.

Path parameters

id (required): Soft-deleted webhook endpoint to permanently delete.

Response

JSON

{
  "success": "boolean"
}

POST /api/webhook-endpoints/{id}/restore

Restore a soft-deleted webhook endpoint.

Path parameters

id (required): Soft-deleted webhook endpoint to restore.

Response

JSON

{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "signatureHeader": "string",
  "signatureAlgo": "string",
  "enabled": "boolean",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}