Webhook map
campaignsstatus(campaigns.status)
eventscreated(events.created)
mailpiecesstatus(mailpieces.status)
webhookstestUrl(webhooks.testUrl)
HTTP handler setup
app/api/webhook/route.ts
Events
Campaigns
Status
campaigns.status
A campaign changed status: printing, dispatched or cancelled; up to 50 campaigns per call
Payload
campaigns full type
campaigns full type
Response data full type
Response data full type
webhookHooks example
Events
Created
events.created
A new recipient event was recorded; up to 50 events per call
Payload
Response data full type
Response data full type
webhookHooks example
Mailpieces
Status
mailpieces.status
A mailpiece changed status: printing, dispatched, cancelled, local_delivery, delivered or returned; up to 50 mailpieces per call
Payload
mailpieces full type
mailpieces full type
Response data full type
Response data full type
webhookHooks example
Webhooks
Test Url
webhooks.testUrl
Validation POST sent once when a webhook is created; the platform keeps the webhook only if this answers HTTP 200
Payload
Response data full type
Response data full type
webhookHooks example