GET /webhook · API reference

Parameters

query

cursorstring | null: The previous page's next_cursor.
sizeinteger | null: Default 25.

Responses

200: Collection_Webhook_; 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' \
  --data-urlencode 'size=50' \
  -H 'Authorization: Bearer $PLACESTACK_API_KEY'

Example response

{
  "object": "list",
  "data": [
    {
      "object": "webhook",
      "id": "whk_01h455vb4pex5vsknk084sn02q",
      "name": "string",
      "url": "<Url>",
      "event_type": [
        "ping"
      ],
      "active": true,
      "secret_fingerprint": "<Secret Fingerprint>",
      "retry_policy": "<RetryPolicy>",
      "created_at": "2026-09-13T12:00:00Z",
      "updated_at": "2026-09-13T12:00:00Z",
      "href": "<Href>"
    }
  ],
  "has_more": true,
  "next_cursor": "string",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}