Skip to main content
GET
List webhooks

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

page
number | null

The 1-based page number to fetch. Omit both page and page_size to fetch all webhooks at once.

Required range: x >= 1
page_size
number | null
default:25

The number of webhooks to return per page.

Required range: 1 <= x <= 100
status
enum<string>

Filter webhooks by their status.

Available options:
active,
inactive,
suspended,
archived,
expired,
error,
unmapped_value,
null
expand
string | null

A comma-separated list of additional fields to expand. Supported values: provider_events (the per-provider event configuration). These are returned as null unless requested.

Example:

"provider_events"

Response

The webhooks were retrieved.

page
number
required

The current page number.

page_size
number
required

The number of webhooks per page.

total
number
required

The total number of webhooks matching the request.

data
object[]
required

The webhooks on this page.