Sign in
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"
    }
  ]
}

Changes

Changed in 4 of the 34 revisions of this API.63

  • 5307993e44d31See the full diff
    • ●

      added the new collection.documents.batch_completed enum value to the /// response property for the response status

      response-property-enum-value-added

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fdb4bdd01a645See the full diff
    • ●

      added the new document.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new document.deleted enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new document.updated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new documents.deleted.batch enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new documents.updated.batch enum value to the /// response property for the response status

      response-property-enum-value-added

  • 72cc17ba6f7f2See the full diff
    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter next_cursor

      new-optional-request-parameter