Agent skill

Shopify Webhooks Skill

Receive and verify Shopify webhooks. Use when setting up Shopify webhook handlers, debugging signature verification, or handling store events like orders/create, products/update, or customers/create.

Install this skill

npx skills add hookdeck/webhook-skills --skill shopify-webhooks

When to Use This Skill

  • Setting up Shopify webhook handlers
  • Debugging signature verification failures
  • Understanding Shopify event types and payloads
  • Handling order, product, or customer events

Verification (core)

Shopify signs the raw body with HMAC-SHA256 keyed on the app's API secret and sends the digest in X-Shopify-Hmac-SHA256 as base64 (not hex). Pass the raw body, decode base64, and compare timing-safe. The topic is in X-Shopify-Topic; the shop domain in X-Shopify-Shop-Domain.

Node:

const crypto = require('crypto');

function verify(rawBody, hmacHeader, secret) {
  if (!hmacHeader) return false;
  const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('base64');
  try {
    return crypto.timingSafeEqual(Buffer.from(hmacHeader), Buffer.from(expected));
  } catch {
    return false;
  }
}

Python:

import hmac, hashlib, base64

def verify(raw_body: bytes, hmac_header: str, secret: str) -> bool:
    if not hmac_header:
        return False
    expected = base64.b64encode(
        hmac.new(secret.encode(), raw_body, hashlib.sha256).digest()
    ).decode()
    return hmac.compare_digest(hmac_header, expected)

Important: Shopify requires the endpoint to respond with 200 within 5 seconds. Process work asynchronously if the handler is slow.

For complete handlers with route wiring, event dispatch, and tests, see:

Common Event Types (Topics)

TopicDescription
orders/createNew order placed
orders/updatedOrder modified
orders/paidOrder payment received
orders/fulfilledOrder shipped
products/createNew product added
products/updateProduct modified
customers/createNew customer registered
app/uninstalledApp removed from store

For full topic reference, see Shopify Webhook Topics

Note: While the REST Admin API is becoming legacy for apps created after April 1, 2025, existing apps can continue using the REST API. New apps should consider using the GraphQL Admin API for webhook management.

Environment Variables

SHOPIFY_API_SECRET=your_api_secret   # From Shopify Partner dashboard or app settings

Local Development

# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 shopify --path /webhooks/shopify

Reference Materials