Documentation menu

Webhooks

API reference

GET /webhook/{webhook}/delivery

List deliveries

Newest first, or oldest first after since.

Parameters

path

webhookrequiredstring
A whk_ id.

query

state"pending" | "delivered" | "failed" | "dead_lettered"[]
No description.
event_typestring[]
No description.
sinceinteger | null
Only deliveries with a greater seq, oldest first.
cursorstring | null
The previous page's next_cursor.
sizeinteger | null
Default 25.

Responses

200
Collection_Delivery_
Successful Response
401
ProblemDetail
credential_missing, credential_invalid or credential_expired: send a live API key as Authorization: Bearer <key>.
402
ProblemDetail
quota_exhausted: the balance can't cover the call. Nothing was charged and nothing was returned.
403
ProblemDetail
scope_missing, person_required or entitlement_missing: this credential or plan can't do this. detail says which.
404
ProblemDetail
no_such_resource: nothing has that id.
409
ProblemDetail
version_conflict: the record changed since you read it. Read it again and resend.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code: a parameter's value isn't one this operation takes.
429
ProblemDetail
rate_limited: wait for Retry-After, then send it again. Not charged.

Example request

curl -G 'https://api.placestack.com/webhook/webhook_123/delivery' \
  --data-urlencode 'state=NC' \
  --data-urlencode 'size=50' \
  -H 'Authorization: Bearer $PLACESTACK_API_KEY'

Example response

{
  "object": "list",
  "data": [
    {
      "object": "webhook_delivery",
      "id": "whd_01h455vb4pex5vsknk084sn02q",
      "seq": 1,
      "event_type": "ping",
      "synthetic": true,
      "subject": "<Subject>",
      "body": {},
      "body_sha256": "<Body Sha256>",
      "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": "string",
      "error": "string",
      "created_at": "2026-09-13T12:00:00Z",
      "attempt": [
        "<DeliveryAttempt>"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}

The rest of webhook.

Next

POST /webhook/{webhook}/delivery

Send a test delivery