List event types

The webhook event types you can subscribe to, and the delivery policy, as data.

GET{BASE_URL}/webhooks/events

Returns every webhook event type with a one-line description, the delivery policy and the endpoint limit. Requires a provider key; the partner header is ignored. Build an event picker or a configuration check from it instead of hard-coding the list.

Response

data.eventsobject[]required: Every event type, each with its name — such as booking.created — and a description. It includes ping, which you cannot subscribe to.
data.delivery.maxAttemptsintegerrequired: Attempts per delivery, the first included.
data.delivery.backoffSecondsinteger[]required: The wait before each retry, in seconds.
data.delivery.timeoutSecondsintegerrequired: How long your endpoint has to answer.
data.delivery.autoDisableThresholdintegerrequired: Consecutive failed attempts after which an endpoint is disabled.
data.delivery.signatureHeaderstringrequired: X-Localoy-Signature.
data.delivery.eventIdHeaderstringrequired: X-Localoy-Event-Id, the key to de-duplicate on.
data.limits.maxEndpointsintegerrequired: How many endpoints you can hold.

Status codes#

Status	Code	Meaning
`200`	—	Success.
`403`	`provider_key_required`	A partner key made the call.

curl "$LOCALOY_BASE_URL/webhooks/events" \
  -H "Authorization: Bearer $LOCALOY_PROVIDER_KEY"

Response · 200 (events shortened)

{
  "success": true,
  "data": {
    "events": [
      {
        "name": "booking.created",
        "description": "A customer booked: an activity booking, a dining reservation, an event RSVP or a ticket order."
      },
      { "name": "connection.revoked", "description": "…" }
    ],
    "delivery": {
      "maxAttempts": 6,
      "backoffSeconds": [10, 20, 40, 80, 160],
      "timeoutSeconds": 10,
      "autoDisableThreshold": 10,
      "signatureHeader": "X-Localoy-Signature",
      "eventIdHeader": "X-Localoy-Event-Id"
    },
    "limits": { "maxEndpoints": 10 }
  }
}