Required scopes:
webhooks_read
Arguments
Forward pagination cursor — returns items after it. Pass an edges[].cursor or
pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor
or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.
Which key to sort by (defaults to the first key, newest-first). Combine with
reverse to flip direction.
Reverses the sort direction selected by orderBy (or its default).
Returns
A paginated list of WebhookEndpoint items.
The list of edges (each a node plus its pagination cursor).
Opaque cursor for this item; pass to after/before to page from here.
The item at this edge.
The API version this endpoint’s deliveries are shaped by.
When the record was created.
An optional merchant-supplied label for the endpoint.
When the endpoint was disabled, or null if active.
Why the endpoint was disabled, or null if active.
The id of this webhook endpoint.
When a pending (staged, not-yet-activated) secret was created, if any.
When the current signing secret became active.
Topics this endpoint is subscribed to.
When the record was last updated.
The URL deliveries are POSTed to.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges.
The API version this endpoint’s deliveries are shaped by.
When the record was created.
An optional merchant-supplied label for the endpoint.
When the endpoint was disabled, or null if active.
Why the endpoint was disabled, or null if active.
The id of this webhook endpoint.
When a pending (staged, not-yet-activated) secret was created, if any.
When the current signing secret became active.
Topics this endpoint is subscribed to.
When the record was last updated.
The URL deliveries are POSTed to.
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to after to page forward.
Whether more items exist after this page (drives forward pagination with first/after).
Whether more items exist before this page (drives backward pagination with last/before).
Cursor of the first edge in this page; pass to before to page backward.
Example