Documentation menu

← Webhooks

API reference

Retrieve a webhook

GET/v1/webhook/{webhook}

Retrieves a webhook's URL, event types, status and retry policy. The signing secret is not included.

Send the response's ETag header as If-Match when you update or delete the webhook.

Parameters

path

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

Responses

200
webhook object
The webhook.
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 -X GET 'https://api.placestack.com/v1/webhook/018f4b75-6f79-7c6a-8c80-000000000001' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "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"
}

Next steps

PATCH /webhook/{webhook}

Update a webhook

Continue