Events

View events related to letters, cheques, postcards, and return envelopes. 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.

Event Response

NameTypeDescription
idstringA unique ID prefixed with event_
objectstringAlways event
typeEventTypeSee event types
livebooleantrue if this is a live mode event else false
dataletter or postcard or cheque or return_envelope_orderThe data of the order associated with this event
updatedFieldsobject or nullA record containing the updated fields of the order associated with the event