webhook

List deliveries

Lists a webhook's deliveries, newest first, or oldest first with since.

Retrieve a single delivery to see its attempts.

get/webhook/{webhook}/delivery

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/webhook/{webhook}/delivery
  • Auth: HTTP bearer

Path parameters

webhookstring required

The webhook's id, whk_....

Query parameters

statestring[]

Only deliveries in these states. One of pending, delivered, failed or dead_lettered. Repeat for several.

event_typestring[]

Only deliveries of these event types. Repeat for several.

sinceinteger nullable

Only deliveries with a seq greater than this. Sorts oldest first.

cursorstring nullable

A cursor for pagination: the next_cursor from the previous page.

sizeinteger nullable

Number of results per page, between 1 and 200. Defaults to 20.

Response

A page of webhook deliveries.

object'list' required

The object's type. Always list.

has_moreboolean required

Whether there are more results after this page.

next_cursorstring nullable required

The cursor for the next page. Send it as cursor. Null on the last page.

suppressedinteger required

The number of matching results withheld because the plan does not include them.

Example response

{
  "data": [
    {
      "id": "whd_01h455vb4pex5vsknk084sn02q",
      "subject": "whk_01h455vb4pex5vsknk084sn02q",
      "body_sha256": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
      "response_body_head": "{\"received\": true}",
      "error": "Connection timed out after 10 seconds.",
      "attempt": [
        {
          "signature": "v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=",
          "response_body_head": "{\"received\": true}",
          "error": "Connection timed out after 10 seconds."
        }
      ]
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.