webhooks

List webhook deliveries

List the webhook delivery log: what was sent, the response received, the number of attempts, and what is still pending. Each entry includes the exact payload that was sent. Results are paginated and can be filtered by endpoint and status. Failed deliveries are retried with increasing delay over roughly 8 to 12 hours before they are given up on.

Notes.

  • Always paged: without ?limit a page has 50 deliveries (not every row, unlike the lists that page only on request), and nextCursor is always present.
  • Needs the permission at the workspace root: a location-scoped key is refused.
get/v1/webhooks/deliveries

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/webhooks/deliveries
  • Auth: HTTP bearer

Query parameters

limitstring

Page size, 1–200. Default 50.

cursorstring

The nextCursor of the previous page.

endpointIdstring

Only this endpoint's deliveries.

status'pending' | 'delivered' | 'failed' | 'abandoned'

Only deliveries in this state. Another value is ignored.

Response

Success.

nextCursorstring nullable required

Send it back as ?cursor= for the next page; null on the last page.

Example response

{
  "data": [
    {
      "id": "whd_8b9c0d1e2f3a4b5c"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.