List webhooks

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

List webhooks

cURL

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

200

{
  "items": [
    {
      "active": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "events": [
        "treasury.payout.awaiting_approval"
      ],
      "id": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "workspaceId": "<string>",
      "principalStatus": "bound",
      "consecutiveFailures": 123,
      "pausedAt": "2023-11-07T05:31:56Z",
      "lastDelivery": {
        "at": "2023-11-07T05:31:56Z",
        "success": true,
        "test": true,
        "statusCode": 1
      }
    }
  ],
  "nextCursor": "<string>"
}

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

Query Parameters

limit · integer<int32>

Page size, default 20, clamped to 1–100

Required range: x >= 0

cursor · string

Opaque nextCursor from this workspace's webhook list

Response

200

application/json

Cursor page of webhooks

A cursor page of workspace webhook endpoints.

items · object[] · required

Show child attributes

nextCursor · string | null · required