Skip to main content
Webhooks

List webhooks

Returns a list of webhooks in your organization using cursor-based pagination.

GET
/v2/webhooks

Query Parameters

  • limit - Number of webhooks to return (1-100, default 10)
  • cursor - Cursor from previous response for pagination
  • status - Filter by status: "active", "paused", or "suspended"

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of webhook objects
  • nextCursor - Cursor for the next page, or null if no more results

Webhook Object

Each webhook includes:

  • id - Unique webhook identifier
  • name - Human-readable webhook name
  • url - Webhook endpoint URL
  • topics - Array of subscribed event topics
  • status - Current status ("active", "paused", "suspended")
  • health - Health metrics (response times, error counts)
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp

Example

{
  "object": "list",
  "data": [
    {
      "object": "webhook",
      "id": "507f1f77bcf86cd799439011",
      "name": "Production Webhook",
      "url": "https://example.com/webhooks",
      "topics": ["post.created", "post.updated"],
      "status": "active",
      ...
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
}

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

limitintegerquerydefault:10

A limit on the number of objects to be returned, between 1 and 100.

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
statusenum<string>query

Filter webhooks by status

Available options: active, paused, suspended
Example: active

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of webhooks

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team