Webhook events catalogwebhook-events-catalog
Use in Plus UI
npx shadcn@latest add https://blocks.plusui.com/r/webhook-events-catalog.jsonReference · 5 variants
← → to step through · + on a thumbnail to compare side by side (up to 3)
/preview/webhook-events-catalog
Open ↗Default content
{
"eyebrow": "Guides",
"title": "Webhooks",
"lead": "Stampcove posts an event to your endpoint whenever a label or a parcel changes. Every event has the same envelope: `id`, `type`, `created_at` and the object in `data`.",
"groups": [
{
"title": "Labels",
"events": [
{
"name": "label.created",
"description": "A label was bought and the PDF is ready to print.",
"payload": "{\n \"id\": \"evt_3Vt8mQ\",\n \"type\": \"label.created\",\n \"created_at\": \"2026-10-08T09:14:02Z\",\n \"data\": {\n \"id\": \"lbl_9Rk2Fz\",\n \"carrier\": \"royal_mail\",\n \"service\": \"tracked_48\",\n \"tracking_number\": \"RM482113907GB\",\n \"label_url\": \"https://files.stampcove.com/lbl_9Rk2Fz.pdf\"\n }\n}"
},
{
"name": "label.voided",
"description": "A label was voided before it shipped; the postage is back on your balance.",
"payload": "{\n \"id\": \"evt_3Vt8nR\",\n \"type\": \"label.voided\",\n \"data\": { \"id\": \"lbl_9Rk2Fz\", \"refund\": { \"amount\": 395, \"currency\": \"gbp\" } }\n}"
}
]
},
{
"title": "Tracking",
"events": [
{
"name": "tracking.updated",
"description": "The carrier scanned the parcel: collected, in transit or out for delivery.",
"payload": "{\n \"id\": \"evt_3Vt9aB\",\n \"type\": \"tracking.updated\",\n \"data\": {\n \"tracking_number\": \"RM482113907GB\",\n \"status\": \"out_for_delivery\",\n \"location\": \"Bristol DO\"\n }\n}"
},
{
"name": "tracking.delivered",
"description": "The parcel was delivered, with a timestamp and, where the carrier gives one, a photo.",
"payload": "{\n \"id\": \"evt_3VtA4c\",\n \"type\": \"tracking.delivered\",\n \"data\": {\n \"tracking_number\": \"RM482113907GB\",\n \"delivered_at\": \"2026-10-09T11:02:40Z\",\n \"proof_url\": \"https://files.stampcove.com/pod_7Yh1.jpg\"\n }\n}"
},
{
"name": "tracking.exception",
"description": "Something went wrong on the way: address problem, damage or a failed delivery.",
"payload": "{\n \"id\": \"evt_3VtB9d\",\n \"type\": \"tracking.exception\",\n \"data\": { \"tracking_number\": \"RM482113907GB\", \"reason\": \"address_not_found\" }\n}"
}
]
}
],
"signing": {
"title": "Verify the signature",
"text": "Each request carries a `Stampcove-Signature` header: an HMAC-SHA256 of the raw body with your endpoint secret. Reject anything that doesn't match.",
"samples": [
{
"label": "Node",
"language": "ts",
"code": "const event = stampcove.webhooks.verify(\n rawBody,\n req.headers[\"stampcove-signature\"],\n process.env.STAMPCOVE_WEBHOOK_SECRET,\n)\n// throws if the signature is wrong or older than 5 minutes"
},
{
"label": "Python",
"language": "python",
"code": "event = stampcove.webhooks.verify(\n raw_body,\n request.headers[\"Stampcove-Signature\"],\n os.environ[\"STAMPCOVE_WEBHOOK_SECRET\"],\n)"
}
]
},
"retries": {
"title": "Retries",
"text": "Answer with any 2xx within 10 seconds. Otherwise we retry on this schedule, then mark the endpoint as failing and email you.",
"schedule": [
"1 min",
"5 min",
"30 min",
"2 h",
"6 h",
"24 h"
]
},
"labels": {
"payload": "Example payload",
"attempt": "Retry",
"copy": "Copy",
"copied": "Copied"
}
}