Webhook endpoints
Retrieve a webhook endpoint
A webhook endpoint by ID (never its secret).
GET
/v1/webhook_endpoints/{id}scope webhooks:readPath parameters
idstringrequiredWebhook endpoint ID (
we_…).
Headers
ZyloPay-VersionstringPin the request to an API version (2026-09-28). Defaults to the version the API key was created with.
Returns
HTTP 200 with the webhook endpoint object.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request (invalid_request_error / idempotency_error). |
401 | Missing, invalid, expired or revoked API key (authentication_error). |
403 | The key lacks the scope, the IP is not allowed, or the account is disabled (permission_error). |
429 | Rate limit reached for this key (rate_limit_error); see Retry-After. |
500 | Internal error (api_error). Retry with the same Idempotency-Key. |
Branch on error.code. Every code is listed in error codes.
Example request
curl https://zylopay-api.fly.dev/api/v1/webhook_endpoints/we_2Lk9Qm4Xz7Pv1Rt8Wb3Ns6Hd \
-H "Authorization: Bearer $ZYLOPAY_SECRET_KEY"Example response
{
"id": "we_2Lk9Qm4Xz7Pv1Rt8Wb3Ns6Hd",
"object": "webhook_endpoint",
"livemode": false,
"url": "https://example.com/zylopay/webhooks",
"description": "Order service (test)",
"enabled_events": [
"payment.succeeded",
"payment_intent.*",
"refund.*"
],
"status": "enabled",
"disabled_reason": null,
"api_version": "2026-09-28",
"failing_since": null,
"last_success_at": "2026-09-28T14:02:41.000Z",
"secret_rotation_ends_at": null,
"created": "2026-09-20T10:00:00.000Z",
"updated": "2026-09-20T10:00:00.000Z"
}