Webhook event types

Courier delivers ten event types. Every one arrives as { "type": "...", "data": {...} }.

How it works

Event type	Fires when
`message:updated`	A message changes status: enqueued, sent, delivered, opened, clicked, undeliverable.
`notification:submitted`	A template send is submitted.
`notification:published`	A template is published.
`notification:submission_canceled`	A submitted send is canceled.
`audiences:created`	An audience is created.
`audiences:updated`	An audience’s definition changes.
`audiences:deleted`	An audience is deleted.
`audiences:calculated`	An audience finishes recalculating its membership.
`audiences:user:matched`	A user newly matches an audience.
`audiences:user:unmatched`	A user no longer matches an audience.

Courier may add event types. Ignore any type your handler does not recognize. Do not treat it as an error.

Payload shape

For message:updated, data is the same object the returns. It includes any metadata you sent (trace_id, tags, event, utm):

{
  "type": "message:updated",
  "data": {
    "id": "1-612fa552-15f7d6ba51bf229857c037a7",
    "event": "SFTYJKSF0241SVH2TWY97TTFFTQG",
    "notification": "SFTYJKSF0241SVH2TWY97TTFFTQG",
    "recipient": "b19fb0e0-8cd6-4337-b41c-92c780c80d1a",
    "recipientId": "b19fb0e0-8cd6-4337-b41c-92c780c80d1a",
    "enqueued": 1630512466717,
    "providers": [],
    "status": "ENQUEUED"
  }
}

The id is Courier’s message id, the same value the Messages API uses.

Limits & behavior

No timestamp in the body. The send time is on the courier-signature header, not inside data.
message:updated fires on every status change. One message produces several events, so make your handler idempotent.
Every destination gets every type. Filter on type yourself. See .

FAQ

How many events will one send produce?

One per status change. A delivered and opened email produces several message:updated events, so key your handler on the message id and the status.

Can I get the metadata I sent with the message?

data carries the metadata from your send, including trace_id, tags, event, and utm.

Get started

Send messages

Journeys

Broadcasts

Design

Recipients

Tenants

Monitoring

Workspaces

Resources

Webhook event types

How it works

Payload shape

Limits & behavior

FAQ

​How it works

​Payload shape

​Limits & behavior

​FAQ

How it works

Payload shape

Limits & behavior

FAQ