Skip to main content

Webhooks Overview

Webhooks allow you to receive notifications of events that occur on our platform. These notifications are delivered to an HTTPS endpoint of your choice.

Setup

Multiple webhook URLs are supported per instance. Administrators can configure webhooks by navigating to SettingsIntegrationsWebhook subscriptions. For each subscription, you can listen to events for all merchant accounts in an instance, or for a specific merchant account.

Legacy Webhook Subscriptions Migration

Before the introduction of the Webhook subscriptions dashboard, webhook configuration was limited:

  • Two webhooks per merchant account, notifications are only sent for successful payments and successful refunds.
  • One hard-coded instance-level webhook, configurable the webhooks using the webhooks_url field in the create transaction request

These legacy subscriptions remain active for now. We are planning an automatic migration, but you can also migrate manually:

  • Merchant-level: While this option has been removed from the dashboard, it may still be active via the API. To migrate, enable a new subscription in SettingsIntegrationsWebhook subscriptions, then unset the legacy URL using the API or via support if needed.
  • Instance-level: Contact support to have this migrated to the new system.

Webhook Delivery Behavior (Legacy vs. New)

Key behaviors to be aware of during the migration period:

  1. Active legacy and new subscriptions will both receive events
    As long as both are active and point to different URLs, each will receive webhook deliveries.
  2. No duplicate deliveries to the same URL
    If both a legacy and a new subscription point to the same URL, our system includes deduplication logic, and only one delivery will go through.
  3. Retries are subscription-specific
    If a webhook delivery fails, it will only be retried for the subscription that encountered the failure—even if other subscriptions (pointing to the same or different URLs) succeed.
  4. Migration will eventually disable legacy subscriptions
    Once automatic migration is complete, only the new subscription system will remain active.

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
  • Basic authentication credentials (username/password)
  • Automatic retries of undelivered events
  • Webhook signatures to verify authenticity

For more details on webhook payloads, event types, and signature verification, please refer to the following documentation sections.

Powered by Docusaurus