Webhooks
Webhooks allow you to receive notifications of events that occurred on our platform. These notifications are delivered to an HTTPS endpoint of your choice.
Setup
We support multiple webhook URLs per instance. Webhooks can be configured by administrators by heading to Settings -> Integrations -> Webhook subscriptions. For each subscription, it’s possible to listen to the events for all merchant accounts in an instance, or to the events for one merchant account.
Legacy webhook subscriptions migration
Before the introduction of our Webhook subscriptions dashboard we support one webhook per merchant account, configured via the Merchants configuration dashboard. We also supported one hard-coded instance-level subscription that was configurable with help from our support team.
For the time being these subscriptions will remain active, though we aim to automatically migrate these soon. To manually migrate these subscriptions please follow these steps.
- For merchant level webhook subscriptions, please enable the webhook subscription URL via Settings -> Integrations -> Webhook subscriptions, and then unset the URL on the merchant dashboard, Settings -> Manage merchants.
- For instance level subscriptions, please contact our support team and they will manually migrate this URL to the new system.
Supported features
- Multiple webhook subscriptions per merchant account
- Merchant account and instance-level webhook subscriptions
- Detailed payloads for transactions, payment methods, buyers, billing details, and most other transaction related events.
- Over 20 different webhook events.
- Basic authentication credentials (username/password)
- Automatic retries of undelivered events
- Webhook signatures to verify authenticity.
Upcoming features
- Event filtering per subscription
- Event log and replay capabilities
Was this page helpful?