List webhook endpoints
GET
/v1/webhooks
curl -X GET "https://us1.platform.bird.com/v1/webhooks" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25" \
--url-query "include_total=false"Returns the workspace's webhook endpoints as a cursor-paginated list, newest first by default. Endpoint objects never include the signing secret; to inspect a single endpoint, use Get a webhook endpoint.
Abfrageparameter
sort
string
Field to sort by: created_at (the default; newest first with the default order) or url.
order
string
Sort direction. Defaults to desc (newest/largest first).
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
include_total
boolean
When true, the response includes a total field with the total number of items matching the request's filters across all pages.
Antwort-Payload
data
array of object
erforderlich
Untergeordnete Attribute anzeigen
data.id
string
erforderlich
Unique identifier for the endpoint (whk_ prefix). Accepted as webhook_id by every /v1/webhooks/{webhook_id} operation.
data.url
string
erforderlich
HTTPS URL Bird delivers this endpoint's events to.
data.description
string
Human-readable label for the endpoint.
data.events
array of string
erforderlich
Event types this endpoint is subscribed to; only matching events are delivered. Change the set with Update a webhook endpoint.
data.status
string
erforderlich
Delivery state of the endpoint.
- active: the initial state; events are being delivered normally.
- degraded: recent deliveries are failing. Bird keeps delivering and retrying, and the endpoint returns to active automatically once deliveries succeed again.
- paused: all delivery is stopped, either because an update set status to paused or automatically after sustained delivery failures. A paused endpoint never resumes on its own: re-enable it with Update a webhook endpoint, then recover the missed events with Replay missed events.
Possible values: active, degraded, paused
data.created_at
string
erforderlich
data.updated_at
string
erforderlich
next_cursor
nullable string
erforderlich
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
erforderlich
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
erforderlich
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
total
nullable integer
Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.