GETTING STARTED

Webhooks

Configure webhooks to receive HTTP notifications when payment or bank account events occur.

The following events are supported:

  • Payment Status Change - Triggered whenever a payment status changes (e.g. Released -> Sent Out)
  • Payment Tracking Added - Triggered whenever a tracking number is added to a payment with supported postage types
  • Bank Account Status Change - Triggered for bank account status updates (currently micro-deposit returns)

Webhooks are sent as HTTP GET requests to a URL you configure, with dynamic values injected using placeholders (e.g. %ID%, %STATUS_NAME%, %TRACKING_NUMBER%).

Configure webhook URLs and review the available placeholders under API -> Webhooks -> Webhook Settings. This section is available in the client portal menu.

Each webhook type can be enabled or disabled independently, and has its own URL configuration.

All webhook activity is logged and can be viewed in:

  • API -> Webhooks -> Payment Webhook History
  • API -> Webhooks -> Payment Tracking Added Webhook History
  • API -> Webhooks -> Bank Account Webhook History

Webhooks are processed asynchronously via a queue and include retry handling in case of temporary failures.

Search documentation