Skip to main content
< All Topics
Print
Posted
Updated
Byadmin

Webhook Overview

Webhooks let your application receive real-time notifications when events occur in a Zencommerce store. Instead of polling the API, you register an HTTPS URL; Zencommerce sends an HTTP POST each time a subscribed event fires.

Your app only needs a publicly reachable HTTPS endpoint that accepts JSON POSTs and verifies our signature.

Who What they do
Merchant Turns webhooks on/off for their store in Admin → Settings → Integrations → Webhooks
Developer Registers a developer account, authenticates, then subscribes HTTPS endpoints to any enabled store by handle

Developers use their own api_key and api_secret (returned when you register). Do not reuse merchant or staff browser session tokens.

API base URL: https://core-api.zencommerce.tech

How an integration works

  1. The merchant enables webhooks and shares the store handle.
  2. The developer registers, obtains a Bearer access token, and creates one subscription per event and destination URL.
  3. When an event occurs, Zencommerce sends a signed JSON POST.
  4. Your receiver verifies the signature, accepts the work durably, and returns HTTP 2xx within 5 seconds.

Credentials and identifiers

Value Purpose
api_key / api_secret Authenticate as a developer and obtain an access token
access_token Authorize subscription management calls
webhook.secret Verify deliveries for a specific subscription (shown once on create or rotate)
Webhook App Secret Partner signing key issued by Zencommerce during partner onboarding
shop_handle Identifies a store in developer API paths
X-Webhook-Id Identifies the subscription that matched the event

Authentication for the Developer API and signature verification of incoming webhooks are separate steps. Keep both sets of secrets secure.

Scroll to Top

Powered by CookieAdmin