Agent skill
Akeneo Webhooks Skill
Receive and verify Akeneo PIM (Events API) webhooks. Use when setting up Akeneo webhook handlers, debugging x-akeneo-request-signature verification, or handling batched product and product-model events like product.created, product.updated, product.removed, product_model.created, product_model.updated, or product_model.removed.
Install this skill
npx skills add hookdeck/webhook-skills --skill akeneo-webhooks
When to Use This Skill
- Setting up Akeneo PIM Events API webhook handlers
- Debugging
x-akeneo-request-signatureverification failures - Understanding Akeneo event types and the batched
eventspayload - Handling product and product-model created/updated/removed events
Verification (core)
Akeneo has no official SDK — verify manually. Each request carries two headers:
x-akeneo-request-signature— hex HMAC-SHA256x-akeneo-request-timestamp— Unix seconds
The signed content is timestamp + "." + rawBody. Compute the HMAC with your connection secret and compare, timing-safe, against the header. Use the raw request body — don't JSON.parse first. Reject stale requests (now - timestamp > 300) to prevent replay.
const crypto = require('crypto');
function verifyAkeneoWebhook(rawBody, signature, timestamp, secret) {
if (!signature || !timestamp) return false;
const age = Math.floor(Date.now() / 1000) - Number(timestamp);
if (!Number.isFinite(age) || Math.abs(age) > 300) return false; // 5-min replay window
const expected = crypto
.createHmac('sha256', secret)
.update(`${timestamp}.`)
.update(rawBody) // Buffer or string of the RAW body
.digest('hex');
try {
return crypto.timingSafeEqual(Buffer.from(signature, 'hex'), Buffer.from(expected, 'hex'));
} catch {
return false; // length mismatch = invalid
}
}
Python equivalent: hmac.new(secret, f"{timestamp}.".encode() + raw_body, hashlib.sha256).hexdigest(), compared with hmac.compare_digest.
For complete handlers with route wiring, event dispatch, and tests, see:
Common Event Types
Akeneo delivers all event types to a single Request URL, so dispatch by action server-side. Payloads are batched: a top-level events array with up to 10 events per request.
Event (action) | Triggered When |
|---|---|
product.created | A product is created |
product.updated | A product is updated |
product.removed | A product is deleted |
product_model.created | A product model is created |
product_model.updated | A product model is updated |
product_model.removed | A product model is deleted |
Category and other resource events are not part of the PIM Events API — they only exist in the newer CloudEvents-based Event Platform.
For full event reference, see Akeneo Events API docs
Environment Variables
AKENEO_WEBHOOK_SECRET=your_connection_secret # From the PIM connection settings
Local Development
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 akeneo --path /webhooks/akeneo
Reference Materials
- references/overview.md - Akeneo webhook concepts and events
- references/setup.md - Enable webhooks in the PIM connection settings
- references/verification.md - Signature verification details and gotchas