maddoxdocs

Webhooks

Manage outbound webhook subscriptions for label.rendered events. The tenant is derived from your API key — never the path — so you can only ever touch your own subscriptions.

Endpoints#

MethodPathPurpose
GET/v1/webhooksList your subscriptions.
GET/v1/webhooks/:idGet one subscription.
POST/v1/webhooks/:idCreate or update a subscription.
DELETE/v1/webhooks/:idDelete a subscription.
GET/v1/webhooks/:id/deliveriesRecent delivery attempts (newest first).

Create / Update#

Only url is required. topics defaults to ["label.rendered"].

cURL
curl -X POST https://api.maddoxapi.dev/v1/webhooks/my-wms \
  -H "Authorization: Bearer $MADDOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/hooks/maddox" }'
Response
{
  "status": "ok",
  "scope": "tenant",
  "id": "my-wms",
  "version": 1,
  "topics": ["label.rendered"],
  "signing_secret": "whsec_…"
}
Cautionsigning_secret is returned once, on create. The url must be public HTTPS; loopback and metadata addresses are rejected.