Documentation menu

← Webhooks

API reference

List event types

GET/v1/event_type

Lists the event types a webhook can subscribe to, with a description of each. Not paginated: has_more is always false.

Parameters

No parameters.

Responses

200
Collection_EventTypeView_
A page of event types.
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/event_type' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "list",
  "data": [
    {
      "object": "event_type",
      "name": "permit.created",
      "description": "A permit was filed on a place on a monitored list."
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}

Next steps

GET /webhook

List webhooks

Continue