Why no official Zapier app yet?
Shoppex does not (yet) ship a Zapier-marketplace app or n8n node. That means you will not see “Shoppex” in Zapier’s app picker. Instead, you wire it up using these general-purpose building blocks:- Webhooks for outbound (Shoppex → automation tool).
- HTTP Request actions for inbound (automation tool → Shoppex API).
- API keys with
Authorization: Bearerfor authentication.
Outbound — Shoppex triggers your automation
Step 1 — Create a Catch Hook in your automation tool
In Zapier:- Create a new Zap.
- Trigger app: Webhooks by Zapier.
- Event: Catch Hook.
- Zapier gives you a URL like
https://hooks.zapier.com/hooks/catch/123456/abcdef/. Copy it.
Step 2 — Register the webhook in Shoppex
Either through the dashboard at Settings → Developer → Webhooks, or through the API:secret. Copy the secret. You will only see
it once. You will not usually verify signatures in Zapier itself, because Zapier does not
expose easy HMAC verification. Keep the secret anyway, for the day you migrate to a real
backend.
Step 3 — Trigger a test event
Either make a real purchase, or use the dashboard’s Send test button on the webhook configuration page. Zapier captures the payload. You will see the order data appear in the Zap editor. Now you can map fields into the next step.Step 4 — Add the action(s)
This is where Zapier shines. Common downstream actions fororder:paid:
- Slack → “send message to #sales channel: New sale: bought for ”
- Notion → “create database row” in your customer DB.
- Google Sheets → “append row” to your accounting tracker.
- Discord → “send webhook message” to a private channel.
- Mailchimp / ConvertKit → “add subscriber” with the buyer’s email.
What payload you get
A typicalorder:paid delivery body looks like:
X-Shoppex-Event— the event name.X-Shoppex-Delivery— unique delivery UUID (use for idempotency).X-Shoppex-Timestamp— unix seconds.X-Shoppex-Signature-V2— HMAC signature (see Webhook handler in a Cloudflare Worker for verification).
Inbound — automation tool writes to Shoppex
The reverse direction: something happens in another app, your Zap calls Shoppex to act on it.Setup
Add an HTTP Request action to your Zap (or “HTTP Request” node in n8n):- Method: POST or PATCH, depending on the endpoint.
- URL:
https://api.shoppex.io/dev/v1/{resource}. - Headers:
Authorization:Bearer shx_your_api_keyContent-Type:application/json
- Body: JSON matching the endpoint’s schema.
Common inbound patterns
Sync a new Stripe customer into Shoppex: When Stripe creates a new customer (Zapier trigger), call:OAuth — for building a real Zapier app
If you eventually publish a marketplace Zapier or n8n integration for other Shoppex merchants, you will switch from per-merchant API keys to OAuth 2.0:- Authorize URL:
https://api.shoppex.io/dev/v1/oauth/authorize(auth-code flow). - Token URL:
https://api.shoppex.io/dev/v1/oauth/token(exchange code for token). - Token prefix:
shpat_for access tokens (1-hour TTL),shprt_for refresh tokens (30-day TTL). - Client credentials: prefixed
shoc_(client ID) andshcs_(client secret).
Common pitfalls
- Treating Zapier’s filter as a security boundary. Without HMAC verification in the automation tool, an attacker who knew your Zapier hook URL can fire fake events. Most webhook attacks are unsophisticated and Zapier hooks are obscure enough to not be a real target, but it is worth knowing. For sensitive flows (money, irreversible actions), use a real backend that verifies signatures. See the Cloudflare Worker tutorial.
- Zapier rate limits. Zapier paid plans have task limits per month. A high-volume
order:paidevent can chew through them fast. Be selective about which events you forward. - Order is paid event being processed before fulfillment finishes. Shoppex fires
order:paidonce payment clears, before the fulfillment outbox (Discord roles, file delivery) has run. If your Zap depends on the buyer “having the product”, wait fororder:completedor watch for the fulfillment-specific events. - Retry window is finite. Shoppex auto-retries failed deliveries with an exponential backoff (2/4/8/16 min) for a total of 5 attempts. If Zapier is paused for longer than ~30 minutes, the delivery uses up its retries and is marked failed. Once Zapier is back, re-queue the delivery manually from the Shoppex webhooks dashboard. You can also periodically scan recent orders through the API to catch anything that slipped through.
Reference: Webhooks
Full event list and payload structures.