Skip to content

Webhook endpoints

A webhook endpoint registers your URL with Paylera and selects which events you want delivered. See Webhooks overview.

Object

{
"id": "we_…",
"object": "webhook_endpoint",
"url": "https://yourapp.example/webhooks/paylera",
"events": ["invoice.paid", "subscription.canceled"],
"description": "production",
"status": "enabled",
"api_version": "2026-04-01",
"secret_last4": "9b2c",
"created_at": "2026-04-01T00:00:00Z",
"updated_at": "2026-04-15T00:00:00Z"
}

The secret is only returned once, on the create or rotate response. It is never readable afterward.

Endpoints

MethodPathWhat
POST/v1/admin/webhook-endpointsCreate. Returns the secret.
GET/v1/admin/webhook-endpoints/{id}Retrieve (no secret).
PATCH/v1/admin/webhook-endpoints/{id}Update events list, status, description.
DELETE/v1/admin/webhook-endpoints/{id}Delete.
GET/v1/admin/webhook-endpointsList.
POST/v1/admin/webhook-endpoints/{id}/rotate-secretRotate. Returns new secret.
GET/v1/admin/webhook-endpoints/{id}/deliveriesList deliveries.
POST/v1/admin/webhook-endpoints/{id}/deliveries/{delivery_id}/retryRetry one delivery.
POST/v1/admin/webhook-endpoints/{id}/replayBulk replay over a window.

Status

statusMeaning
enabled (default)Receiving deliveries.
disabledNot receiving deliveries (manual).
auto_disabledDisabled by Paylera after 100 consecutive 4xx responses.

Re-enable an auto_disabled endpoint after fixing the handler:

PATCH /v1/admin/webhook-endpoints/{id}
{ "status": "enabled" }

API version

Endpoints can pin a specific API version for the event payload shape:

{ "api_version": "2026-04-01" }

If unset, deliveries use the version that was current when the endpoint was created.

Webhook events (about webhooks)

webhook_endpoint.created, webhook_endpoint.updated, webhook_endpoint.disabled, webhook_endpoint.delivery_failed. Note: when an endpoint goes disabled, the meta-events fire to your other endpoints, not to the failing one.