StoreWebhookRequest | ePay documentation

Payload for registering a webhook endpoint.

urlstring

Required

HTTPS URL that will receive webhook notifications. Must match one of your approved point-of-sale domains.

Format:

uri

List of webhook events to subscribe to. Duplicate values are rejected.

Items:

1 <= items

Array [

string

Possible values:

"transaction.success.v1""transaction.failed.v1""transaction.captured.v1""transaction.refunded.v1""transaction.voided.v1""transaction.renewed.v1""subscription.disabled.v1""subscription-billing.charge-created.v1""subscription-billing.charge-success.v1""subscription-billing.charge-failed.v1""subscription-billing.agreement-active.v1""subscription-billing.agreement-stopped.v1""settlement.transfer-ready.v1"

]

secretstring

Required

Shared secret used as the value of the Authorization header during webhook callback.

Length:

1 <= length <= 2048