List endpoints

List all of your webhook endpoints, newest first.

GET{BASE_URL}/webhooks

Returns all of your webhook endpoints, in both environments, newest first. The list is not paginated: you can hold at most 10. Requires a provider key; the partner header is ignored.

No endpoint in the list carries its signing secret. See The signing secret.

Response

dataobject[]required: Your webhook endpoints.

Status codes#

Status	Code	Meaning
`200`	—	Success. With no endpoints, `data` is empty.
`403`	`provider_key_required`	A partner key made the call.

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

Response · 200

{
  "success": true,
  "data": [
    {
      "id": "cm8wh00k0000000000000002",
      "url": "https://staging-hooks.example.com/localoy",
      "description": null,
      "environment": "SANDBOX",
      "events": ["catalog.item.created", "catalog.item.updated", "catalog.item.deleted"],
      "status": "ENABLED",
      "secretPreview": "whsec_b7Kq2n…",
      "consecutiveFailures": 0,
      "…": "…"
    },
    {
      "id": "cm8wh00k0000000000000001",
      "url": "https://hooks.example.com/localoy",
      "description": "Production receiver",
      "environment": "PRODUCTION",
      "events": ["booking.created", "booking.updated", "booking.cancelled", "connection.updated", "connection.revoked"],
      "status": "ENABLED",
      "secretPreview": "whsec_Xq9vT0…",
      "consecutiveFailures": 0,
      "…": "…"
    }
  ]
}