Skip to content
MiniApps/
E-commerce
Last updated

E-commerce integrations

E-commerce MiniApps connect storefront platforms (Salla, Zid, custom stacks) to Karzoun orders, customers, products, and abandoned carts.

Use the sync block — not legacy webhook.ecommerce.

CapabilityConfiguration
Bulk importsync.resources.* with apiMapping
Realtime orders/cartssync.webhooks.handlers
Automation reactionsMatching triggers[] entries
Customer linkingwebhook.customerExtraction

Full reference: Sync guide.

Typical flow

Karzoun CRM / TasksKarzoun MiniApp runtimeStore platformKarzoun CRM / TasksKarzoun MiniApp runtimeStore platformWebhook order.createdVerify signature + extract eventsync.webhooks.handlers mappingRecord created/updated200 OK
  1. Tenant installs your MiniApp from Marketplace.
  2. OAuth or API key stores credentials on the tenant install.
  3. Provider webhooks hit POST /miniapps/{ns}/webhooks.
  4. Handlers map payloads into Karzoun commerce records.
  5. Automations use triggers (e.g. order.created) for workflows.

What to include in your definition

  • OAuth 2.0 with auto_refresh: true for platforms that issue refresh tokens
  • webhook.verification — HMAC or token strategy from your provider
  • webhook.customerExtraction — Map buyer fields into Karzoun customers
  • sync.resources — Products, customers, orders as needed
  • sync.webhooks.handlers — Create/update mappings per event
  • triggers — One per automation-visible event

See the Salla example for a complete pattern.

Legacy webhook.ecommerce

webhook.ecommerce is deprecated. New submissions must use sync. Karzoun may reject definitions that rely solely on the legacy block.

If you are maintaining an older integration, contact Karzoun support for a migration review.

Partners

Commerce partners (Salla, Zid, Matjrah) should also read the Partners program for whitelabel and embedded onboarding flows.

Previous page
Next page