Documentation menu

← Webhooks

API reference

List webhooks

GET/v1/webhook

Lists webhooks by name, with unnamed ones last.

Not paginated: has_more is always false. Deleted webhooks are not included.

Parameters

No parameters.

Responses

200
array of webhook objects
A page of webhooks.
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.
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 -X GET 'https://api.placestack.com/v1/webhook' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "list",
  "data": [
    {
      "object": "webhook",
      "id": "whk_01h455vb4pex5vsknk084sn02q",
      "name": "Production",
      "url": "https://example.com/webhooks/placestack",
      "event_type": [
        "permit.created"
      ],
      "active": true,
      "secret_fingerprint": "9f86d081",
      "retry_policy": {
        "max_attempt": 12,
        "backoff": "exponential",
        "base_seconds": 60,
        "jitter": true,
        "dead_letter_after_hours": 24
      },
      "created_at": "2026-09-13T12:00:00Z",
      "updated_at": "2026-09-13T12:00:00Z",
      "href": "/webhook/whk_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}

Next steps

POST /webhook

Create a webhook

Continue