List webhook subscriptions

data

• webhooksobject[]
• webhooks[].idstringrequired
• webhooks[].urlstringrequired
• webhooks[].eventsstring[]required
• webhooks[].activebooleanrequired
• webhooks[].modestringrequired

  Which order mode this subscription accepts. Normalised on the way out, so a stored value this build does not know reads as what it is actually routed as (all) rather than as the stored string.

  One of all test live

• webhooks[].created_atstring (date-time)required
• webhooks[].secret_rotated_atstring (date-time) | null
• webhooks[].previous_secret_expires_atstring (date-time) | null

  During a rotation both secrets verify until this moment. Sign-check against both, or accept the older one, until it passes.

• webhooks[].rotation_pendingboolean

  True while the previous secret is still inside its window.

• webhooks[].inboxbooleanrequired

  True for the account's hosted test inbox (POST /v1/webhooks/inbox): it receives test events only and keeps them for GET /v1/webhooks/inbox rather than POSTing them, its url is the dashboard page that shows them, and its url and mode cannot be changed.

• next_cursorstring | null

  The same as meta.next_cursor: send it back as cursor for the next page. Null on the last.

meta

• pageintegerdeprecated

  The page number of the deprecated offset walk, on the lists that published it (orders and an order's events, on every request without cursor; products, on a request that sent page). Absent on a cursor walk, where no page number would be true.

• totalinteger

  Every row matching the request's filters, on the lists that count them (orders, an order's events, assets and products).

• limitinteger

  The page size applied, which is not necessarily the one asked for: a larger limit is clamped. Absent only on a GET /products request without cursor that sent no limit, which answers every match.

• pagesintegerdeprecated

  total over limit, rounded up, beside page (orders and an order's events). Absent on a cursor walk.

• next_cursorstring | nullrequired

  Send it back as cursor for the next page; null exactly when has_more is false. Opaque: pass it back unchanged. Good only on the list that returned it, with a key of the same account and mode (test or live), and with the same filters.

• has_morebooleanrequired

  Whether another page follows this one. Decided from one row past this page, never from a page that came back short — so a page after has_more: true can come back empty only if rows were deleted in between, and the walk still ends at the first has_more: false.

• sincestring | null

  On GET /order/{id}/events only: where to ask from next — the position of the last event in this answer, or, when it has none, the position the request read from. Send it back as since (with wait_seconds to wait for the next event). Unlike next_cursor it is not null at the end of the history; it is null only when the order has no events and the request named no position. Opaque, and bound like a cursor to this order, account and key mode.