WebhookResource | ePay documentation

Object containing the webhook resource.

Webhook configuration returned by the API.

idstring

Required

Unique identifier of the webhook.

Format:

uuid

urlstring

Required

Destination URL configured for webhook delivery.

Format:

uri

Events the webhook is subscribed to.

pausedAtstring

Nullable

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.

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.

Format:

date-time

pauseReasonstring

Nullable

Reason for pausing the webhook. Will be null if the webhook is not paused.

Reason for pausing the webhook. Will be `null` if the webhook is not paused.

Possible values:

"ERROR_RATE_TOO_HIGH""PAUSED_BY_MERCHANT"

createdAtstring

Required

Timestamp when the webhook was created.

Format:

date-time

WebhookResource

{  "webhook": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "url": "http://example.com",    "events": [      "subscription-billing.charge-created.v1"    ],    "pausedAt": "2019-08-24T14:15:22Z",    "pauseReason": "ERROR_RATE_TOO_HIGH",    "createdAt": "2019-08-24T14:15:22Z"  }}