Admin Webhooks

Admin Webhooks allow your system to receive notifications about key business events relating to customers, orders, products, or payments.

Access & Permissions

To work with Admin Webhooks, the following permissions are required:

• View Webhooks
  Permission: admin_api_webhook__show
  Grants access to the Admin Webhooks overview page.
• Create or Edit Webhooks
  Permission: admin_api_webhook__edit
  Required to create new webhooks or view/edit existing ones.

Overview Page

The Admin Webhooks overview page displays all configured webhooks with the following details:

• ID: Unique identifier
• Event name: The specific event the webhook listens to (e.g. customer-created, order-cancelled)
• Included merchants: Merchants the webhook applies to (if specified)
• URL: The destination endpoint for webhook delivery
• Version: The payload version used

Users can filter this list by:

• Event name
• Version

Creating a Webhook

With the required permission, the user can use the button "Add New Webhook" on the Overview page. When creating a webhook, the user must provide:

• Event name: The event to subscribe to
• URL: The endpoint to receive the webhook
• Version: The version used

Optionally, the user can include or exclude specific merchants. In case inlcuded or excluded merchants are specified, the webhook will only refer to those merchants. If none are selected, the webhook applies to all merchants in the environment.

⚠️ Not all events support merchant filtering.
To check which events support merchant filtering, see:
Webhook Subscription Filters in the Developer Guide