WebhookResource

Object containing the webhook resource.

webhook object

Webhook configuration returned by the API.

iduuidrequired

Unique identifier of the webhook.

urlurirequired

Destination URL configured for webhook delivery.

eventsstring[]required

Events the webhook is subscribed to.

Possible values: [subscription-billing.charge-created.v1, subscription-billing.charge-failed.v1, subscription-billing.charge-success.v1, subscription-billing.agreement-active.v1, subscription-billing.agreement-stopped.v1, settlement.transfer-ready.v1]

pausedAtdate-timenullable

If not null it means the webhook is currently paused. A webhook can be pause either manually in the ePay backoffice or automatically by ePay, if the webhook error rate is too high.

createdAtdate-timerequired

Timestamp when the webhook was created.

WebhookResource

{
  "webhook": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "url": "string",
    "events": [
      "subscription-billing.charge-created.v1"
    ],
    "pausedAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z"
  }
}