The webhook endpoint object

Endpoints, signing secrets and the delivery log.

EndpointsCopy Anchor Link

• GET /v1/webhook_deliveries/{id}: Retrieve a delivery
• POST /v1/webhook_deliveries/{id}/retry: Resend a delivery
• GET /v1/webhook_endpoints: List webhook endpoints
• POST /v1/webhook_endpoints: Create a webhook endpoint
• GET /v1/webhook_endpoints/{id}: Retrieve a webhook endpoint
• PATCH /v1/webhook_endpoints/{id}: Update a webhook endpoint
• DELETE /v1/webhook_endpoints/{id}: Delete a webhook endpoint
• GET /v1/webhook_endpoints/{id}/deliveries: List deliveries of an endpoint
• POST /v1/webhook_endpoints/{id}/rotate_secret: Rotate the signing secret
• POST /v1/webhook_endpoints/{id}/test: Send a test event

AttributesCopy Anchor Link

idstring

Unique identifier (we_…).

objectstring

livemodeboolean

urlstring

descriptionstring | null

enabled_eventsarray of strings

["*"] or the subscribed event types.

statusstring

One of: enabled, disabled

disabled_reasonstring | null

One of: merchant, failing

failing: disabled automatically after failing for 3 days.

api_versionstring

failing_sincestring (date-time) | null

First failure since the last successful delivery (null while healthy).

last_success_atstring (date-time) | null

Last successful delivery.

secret_rotation_ends_atstring (date-time) | null

While set, deliveries are also signed with the previous secret (rotation overlap).

secretstring

Signing secret (whsec_…). Returned ONLY when the endpoint is created or its secret rotated: store it now.

createdstring (date-time)

Creation time.

updatedstring (date-time)

Last change.

ExampleCopy Anchor Link

{
  "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"
}