W

Webhooks

Name: Webhooks
Author: Xross-dev

Medusa v2 webhooks plugin: admin UI, HMAC-signed deliveries, durable DB-backed retries (no workflow engine / Redis dependency).

npm install @xross-dev/medusa-webhooks

Категория

Панель администратора

Создано

Xross-dev

Версия

3.1.0

Последнее обновление

1 день назад

Ежемесячные загрузки

NPM

@xross-dev/medusa-webhooks

Outgoing webhooks for Medusa v2: manage them from the admin, get HMAC-signed deliveries, and automatic retries that are stored in your database and re-run by a scheduled job. No Medusa workflow-engine retries, so nothing here depends on Redis workflow scheduling.

Originally based on the MIT-licensed webhooks plugin; v3 is a rewrite.

Install

npm install @xross-dev/medusa-webhooks

1// medusa-config.ts
2plugins: [
{
  resolve: "@xross-dev/medusa-webhooks",
  options: {
    subscriptions: ["product.created", "product.updated", "order.placed"],
    // all optional
    timeoutMs: 10000,
    blockPrivateNetworks: true,          // default: true in production, false otherwise
    retryDelaysSeconds: [60, 300, 1800], // 3 retries after the first attempt
    retentionDays: 30,                   // finished deliveries are purged after this
  },
},
14],

npx medusa db:migrate

The retry job (, every minute) runs wherever Medusa runs scheduled jobs: the server in the default mode, or the worker instance when you use .

Send events

1// src/subscribers/product-webhooks.ts
2import type { SubscriberArgs, SubscriberConfig } from "@medusajs/framework";
3import { dispatchWebhooks } from "@xross-dev/medusa-webhooks/dispatch";
4
5export const config: SubscriberConfig = { event: ["product.created", "product.updated"] };
6
7export default async function handler({ event: { name, data }, container }: SubscriberArgs<{ id: string }>) {
8  const query = container.resolve("query");
9  const { data: [product] } = await query.graph({ entity: "product", fields: ["*"], filters: { id: data.id } });
10
11  await dispatchWebhooks(container, name, product);
12}

never throws. It returns .

HTTP methods

Each webhook has a method: (default), , , or .

Method	Body	Event data
	JSON (the event data)	body, and optionally URL placeholders
	none	URL placeholders only

and carry no body (HTTP semantics; rejects a body). Put the data you need in the URL with filled from the event data, URL-encoded:

1DELETE https://api.example.com/products/{id}
2GET    https://api.example.com/sync?sku={variant.sku}&tag={tags[0]}

Placeholders work in the path and query only, not the host (SSRF guard).
If a value is missing from the event data the delivery fails immediately with a clear error and no request is sent.
Send test uses for . For // the admin asks for confirmation first, because the test is a real request.
Duplicates are checked on event + method + URL.

How delivery works

Each active webhook for the event gets one request, in parallel.
2xx = success. Timeouts, network errors, 408, 429 and 5xx are retried after 1, 5 and 30 minutes (first attempt + 3 retries). Other 4xx, redirects and blocked targets fail immediately.
State lives in the table ( / / ). The payload is kept only while a retry may still happen and is cleared on success. It is never returned by the API.
Retry now in the admin starts a fresh cycle for a failed delivery.
Deleting or deactivating a webhook ends its pending retries.

Receiver headers: , , (same value on every retry of one delivery), , . Body is the raw event data (empty for /, in which case the signature is computed over an empty body).

1import { createHmac, timingSafeEqual } from "node:crypto";
2
3export function verify(rawBody: string, header: string, secret: string, toleranceSec = 300) {
4  const [t, v1] = header.split(",").map((p) => p.split("=")[1]);
5  if (Math.abs(Date.now() / 1000 - Number(t)) > toleranceSec) return false;
6  const expected = createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex");
7  return v1.length === expected.length && timingSafeEqual(Buffer.from(v1), Buffer.from(expected));
8}

Admin API ()

Method & path	Notes
	, , , , , ,
	returns (shown once)
· ·	accepts . also removes its deliveries
	, , ,
	manual retry
	events grouped for the UI
	sends a real, signed test request, not stored

Notes

Upgrading from 3.0: run (adds a column, default ; existing webhooks are unchanged).
Upgrading from : the migration keeps the table and adds columns. Old webhooks have no secret until you click Rotate.
SSRF guard is best-effort against DNS rebinding; also restrict egress at the network level.
Two instances running the job at the same moment could double-send one retry (rows are leased for 5 min to make this unlikely). Receivers should be idempotent, especially for /, which a retry after a timeout can repeat: dedupe on .