API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Events

View Events related to your orders.

An event is created whenever a webhook is triggered. For example, if a webhook is created that listens to letter.updated events and the delivery status of a letter is updated, an event detailing the updated fields will get created.

List Events

client.printMail.events.list(EventListParams { limit, skip, type } query?, RequestOptionsoptions?): SkipLimit<Event { id, createdAt, live, 4 more } >

GET/print-mail/v1/events

ModelsExpand Collapse

Event { id, createdAt, live, 4 more }

id: string

A unique ID prefixed with event_.

createdAt: string

The UTC time at which this event was created.

formatdate-time

live: boolean

true if this is a live mode event else false.

object: "event"

Always event.

type: "letter.created" | "letter.updated" | "postcard.created" | 18 more

The type of event that a Webhook can listen for and that an Event represents.

One of the following:

"letter.created"

"letter.updated"

"postcard.created"

"postcard.updated"

"self_mailer.created"

"self_mailer.updated"

"cheque.created"

"cheque.updated"

"box.created"

"box.updated"

"snap_pack.created"

"snap_pack.updated"

"return_envelope_order.created"

"return_envelope_order.updated"

"tracker.visited"

"campaign.created"

"campaign.updated"

"virtual_mailbox_item.created"

"postal_statement.created"

"document.created"

"document.updated"

data?: Record<string, unknown>

The data of the resource associated with this event.

updatedFields?: Record<string, unknown>

A record containing the updated fields of the resource associated with this event.