mcpField
W
woocommerce-webhooks

woocommerce-webhooks

github.com/hookdeckDevelopment95212 installsUpdated today
Repository

About woocommerce-webhooks

woocommerce-webhooks is a skill for developers integrating WooCommerce webhooks. It covers signature verification, event payloads, and handler examples for several frameworks.

Key features

  1. 01Webhook signature verification examples
  2. 02Order, product, and customer event reference
  3. 03Express, Next.js, and FastAPI examples
  4. 04Local tunnel testing instructions

Use cases

  1. 01Trigger notifications for order changes
  2. 02Sync product data to external catalogs
  3. 03Debug signature verification failures
  4. 04Inspect webhook requests locally

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/hookdeck/webhook-skills --skill woocommerce-webhooks

After installing, type/woocommerce-webhooksin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

examples/express/
.env.example
package.json
README.md
examples/express/src/
index.js
examples/express/test/
webhook.test.js
examples/fastapi/
.env.example
main.py
README.md
requirements.txt
test_webhook.py
examples/nextjs/
.env.example
package.json
README.md
vitest.config.ts
examples/nextjs/app/webhooks/woocommerce/
route.ts
examples/nextjs/test/
webhook.test.ts
references/
overview.md
setup.md
verification.md

Details

From the project README

WooCommerce Webhooks

When to Use This Skill

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

Essential Code (USE THIS)

WooCommerce Signature Verification (JavaScript)
const crypto = require('crypto');

function verifyWooCommerceWebhook(rawBody, signature, secret) {
  if (!signature || !secret) return false;
  
  const hash = crypto
    .createHmac('sha256', secret)
    .update(rawBody)
    .digest('base64');
  
  try {
    return crypto.timingSafeEqual(
      Buffer.from(signature), 
      Buffer.from(hash)
    );
  } catch {
    return false;
  }
}
Express Webhook Handler
const express = require('express');
const app = express();

// CRITICAL: Use raw body for signature verification
app.use('/webhooks/woocommerce', express.raw({ type: 'application/json' }));

app.post('/webhooks/woocommerce', (req, res) => {
  const signature = req.headers['x-wc-webhook-signature'];
  const secret = process.env.WOOCOMMERCE_WEBHOOK_SECRET;
  
  if (!verifyWooCommerceWebhook(req.body, signature, secret)) {
    return res.status(400).send('Invalid signature');
  }
  
  const payload = JSON.parse(req.body);
  const topic = req.headers['x-wc-webhook-topic'];
  
  console.log(`Received ${topic} event:`, payload.id);
  res.status(200).send('OK');
});
Next.js API Route (App Router)
import crypto from 'crypto';
import { NextRequest } from 'next/server';

export async function POST(request: NextRequest) {
  const signature = request.headers.get('x-wc-webhook-signature');
  const secret = process.env.WOOCOMMERCE_WEBHOOK_SECRET;
  
  const rawBody = await request.text();
  
  if (!verifyWooCommerceWebhook(rawBody, signature, secret)) {
    return new Response('Invalid signature', { status: 400 });
  }
  
  const payload = JSON.parse(rawBody);
  const topic = request.headers.get('x-wc-webhook-topic');
  
  console.log(`Received ${topic} event:`, payload.id);
  return new Response('OK', { status: 200 });
}
FastAPI Handler
import hmac
import hashlib
import base64
from fastapi import FastAPI, Request, HTTPException

app = FastAPI()

def verify_woocommerce_webhook(raw_body: bytes, signature: str, secret: str) -> bool:
    if not signature or not secret:
        return False
    
    hash_digest = hmac.new(
        secret.encode(),
        raw_body,
        hashlib.sha256
    ).digest()
    expected_signature = base64.b64encode(hash_digest).decode()
    
    return hmac.compare_digest(signature, expected_signature)

@app.post('/webhooks/woocommerce')
async def handle_webhook(request: Request):
    raw_body = await request.body()
    signature = request.headers.get('x-wc-webhook-signature')
    secret = os.getenv('WOOCOMMERCE_WEBHOOK_SECRET')
    
    if not verify_woocommerce_webhook(raw_body, signature, secret):
        raise HTTPException(status_code=400, detail='Invalid signature')
    
    payload = await request.json()
    topic = request.headers.get('x-wc-webhook-topic')
    
    print(f"Received {topic} event: {payload.get('id')}")
    return {'status': 'success'}

Common Event Types

EventTriggered WhenCommon Use Cases
order.createdNew order placedSend confirmation emails, update inventory
order.updatedOrder status changedTrack fulfillment, send notifications
order.deletedOrder deletedClean up external systems
product.createdProduct addedSync to external catalogs
product.updatedProduct modifiedUpdate pricing, inventory
customer.createdNew customer registeredWelcome emails, CRM sync
customer.updatedCustomer info changedUpdate profiles, preferences

Environment Variables

WOOCOMMERCE_WEBHOOK_SECRET=your_webhook_secret_key

Headers Reference

WooCommerce webhooks include these headers:

  • X-WC-Webhook-Signature - HMAC SHA256 signature (base64)
  • X-WC-Webhook-Topic - Event type (e.g., "order.created")
  • X-WC-Webhook-Resource - Resource type (e.g., "order")
  • X-WC-Webhook-Event - Action (e.g., "created")
  • X-WC-Webhook-Source - Store URL
  • X-WC-Webhook-ID - Webhook ID
  • X-WC-Webhook-Delivery-ID - Unique delivery ID

Local Development

For local webhook testing, install Hookdeck CLI:

Then start the tunnel:

npx hookdeck-cli listen 3000 woocommerce --path /webhooks/woocommerce

No account required. Provides local tunnel + web UI for inspecting requests.

Reference Materials

  • overview.md - What WooCommerce webhooks are, common event types
  • setup.md - Configure webhooks in WooCommerce admin, get signing secret
  • verification.md - Signature verification details and gotchas
  • examples/ - Complete runnable examples per framework

Recommended: webhook-handler-patterns

For production-ready webhook handlers, also install the webhook-handler-patterns skill for:

Related Skills

Comments

Markdown supported