Retrieve an endpoint

Read one of your webhook endpoints, including its health.

GET{BASE_URL}/webhooks/{id}

Returns one of your webhook endpoints, without its signing secret. Requires a provider key; the partner header is ignored. Watch status, consecutiveFailures and lastError to see whether your receiver is healthy.

Path parameters

idstringrequired
The endpoint's ID.

Response

dataobjectrequired
The webhook endpoint.

Status codes#

StatusCodeMeaning
200—Success.
403provider_key_requiredA partner key made the call.
404webhook_endpoint_not_foundYou have no endpoint with that ID.
curl "$LOCALOY_BASE_URL/webhooks/cm8wh00k0000000000000001" \
  -H "Authorization: Bearer $LOCALOY_PROVIDER_KEY"
Response · 200
{
  "success": true,
  "data": {
    "id": "cm8wh00k0000000000000001",
    "url": "https://hooks.example.com/localoy",
    "description": "Production receiver",
    "environment": "PRODUCTION",
    "events": ["booking.created", "connection.updated", "connection.revoked"],
    "status": "DISABLED",
    "disabledAt": "2026-09-27T14:02:51.118Z",
    "disabledReason": "…",
    "secretPreview": "whsec_Xq9vT0…",
    "secretRotatedAt": null,
    "lastSuccessAt": "2026-09-27T11:05:42.611Z",
    "lastFailureAt": "2026-09-27T14:02:51.118Z",
    "lastError": "Receiver returned 503",
    "consecutiveFailures": 10,
    "createdAt": "2026-09-27T09:30:00.000Z",
    "updatedAt": "2026-09-27T14:02:51.118Z"
  }
}