v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Webhooks

List Webhooks

List all webhooks for the user's organization.

post/v1/organizations/webhooks/list

Query parameters

limitinteger nullable

page_sizeinteger nullable

offsetinteger nullable

pageinteger nullable

cursorstring nullable

next_cursorstring nullable

afterstring nullable

include_totalboolean

Request body

event_typestring nullable

Filter by event type

is_activeboolean nullable

Filter by active status

Response

Successful Response

totalinteger required

Total number of webhooks

Example response

{
  "results": [
    {
      "channels": [
        {
          "channel": "slack",
          "configs": {
            "bot_token": "xoxb-...",
            "channel_id": "C0123456789",
            "workspace_id": "T0123456789"
          }
        }
      ],
      "created_at": "2025-01-01T00:00:00Z",
      "description": "Slack notifications for object lifecycle",
      "event_types": [
        "object.created",
        "object.updated",
        "object.deleted"
      ],
      "is_active": true,
      "updated_at": "2025-01-01T00:00:00Z",
      "webhook_id": "wh_abc123def4",
      "webhook_name": "Engineering Slack Alerts"
    }
  ]
}