Documentation menu

← Webhooks

API reference

List deliveries

GET/v1/webhook/{webhook}/delivery

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

Retrieve a single delivery to see its attempts.

Parameters

path

webhookrequiredstring
The webhook's id, whk_....

query

state"pending" | "delivered" | "failed" | "dead_lettered"[]
Only deliveries in these states. One of pending, delivered, failed or dead_lettered. Repeat for several.
event_type"permit.created" | "case.created"[]
Only deliveries of these event types. Repeat for several.
sinceinteger | null
Only deliveries with a seq greater than this. Sorts oldest first.
cursorstring | null
A cursor for pagination: the next_cursor from the previous page.
sizeinteger | null
Number of results per page, between 1 and 200. Defaults to 20.

Responses

200
Collection_Delivery_
A page of webhook deliveries.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
404
ProblemDetail
no_such_resource. No object has that id.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Credits

Free.

Example request

curl -G 'https://api.placestack.com/v1/webhook/018f4b75-6f79-7c6a-8c80-000000000001/delivery' \
  --data-urlencode 'state=NC' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "list",
  "data": [
    {
      "object": "webhook_delivery",
      "id": "whd_01h455vb4pex5vsknk084sn02q",
      "seq": 1,
      "event_type": "permit.created",
      "synthetic": true,
      "subject": "whk_01h455vb4pex5vsknk084sn02q",
      "body": {},
      "body_sha256": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
      "state": "pending",
      "attempt_count": 1,
      "next_attempt_at": "2026-09-13T12:00:00Z",
      "delivered_at": "2026-09-13T12:00:00Z",
      "dead_lettered_at": "2026-09-13T12:00:00Z",
      "response_status": 1,
      "response_body_head": "{\"received\": true}",
      "error": "Connection timed out after 10 seconds.",
      "created_at": "2026-09-13T12:00:00Z",
      "attempt": [
        {
          "attempt": 1,
          "attempted_at": "2026-09-13T12:00:00Z",
          "duration_ms": 1,
          "timestamp": 1,
          "signature": "v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4=",
          "response_status": 1,
          "response_body_head": "{\"received\": true}",
          "error": "Connection timed out after 10 seconds."
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}

Next steps

POST /webhook/{webhook}/delivery

Send a test delivery

Continue