Skip to main content

Webhook Overview - Receive Real-Time Data Change Notifications

Webhook is a feature that lets partner or third-party systems automatically receive notifications whenever your store's data changes — for example when a new order is created, a customer updates their phone number, inventory moves, or a product's price changes.

Instead of repeatedly calling the API to check for new data (polling), the partner system simply registers a webhook URL. When an event occurs, the system automatically sends (POST) the event data to that URL in real time.

Overview​

The Webhook feature lives in Settings → Store Settings → API Key, with 3 tabs:

TabPurpose
API KeyManage the store's API Key (used for the Open API)
WebhookConfigure the receiving URL, authentication method and the events to subscribe to
Webhook delivery historyTrack every webhook delivery: status, attempt count, HTTP response code and payload content
Requirements

The Webhook feature is tied to the store's API Key. Your store needs a service package with the API Key Integration feature enabled, and an API Key must be created before configuring a webhook.

How it works​

  1. The store configures the webhook: enter the receiving URL, choose an authentication method and the events to receive, then activate it.
  2. When a subscribed event occurs (e.g. a new order), the system creates a delivery record and puts it into a processing queue.
  3. The system sends an HTTP POST containing the event data (JSON) to the registered URL, with the corresponding authentication headers.
  4. If the receiving server responds with a 2xx code → the delivery is marked Delivered. On failure → the system automatically retries on a backoff schedule (5 minutes → 30 minutes → 3 hours), up to 4 attempts in total.
  5. The entire process is recorded in the Webhook delivery history tab for auditing.

Supported event groups​

The system currently supports 24 event types across 9 data groups:

  • Orders — created, status changed, paid, cancelled
  • Customers — created, phone updated, followed OA, other updates
  • Inventory — changed by orders, warehouse transfers, manual adjustments, bulk imports, deletions
  • Products — created, updated, deleted
  • ZNS messages — delivery status changed
  • ZNS campaigns — campaign status changed
  • Inquiries — created, processing status changed
  • Reviews — created, approval status changed
  • Loyalty points — created, status changed

For details on each event and the payload structure, see Events & Payload.

Benefits​

  • Receive data changes in real time, with no need for constant API polling
  • Reduce load on both systems and save infrastructure costs
  • Support for 3 authentication methods (none / API Key headers / HMAC signature) to match different security levels
  • Automatic retry on failed deliveries, so no event is silently lost
  • A complete delivery history for fast auditing and troubleshooting
Quick start

Follow the step-by-step guide in Webhook Configuration to set up your first webhook in just a few minutes.