Skip to main content

Input fields

description : String! required

Explanation or context for the event.

eventId : String

Unique identifier for this event from the external vendor, if provided. Used for deduplication so that requests can be safely retried without creating duplicate events.

eventType : String! required

Type of post event (ie. 'delivered', 'returned', 'failed').

messageId : String! required

Unique ID of the message (ie. letter or document) that this post event relates to.

timestamp : DateTime! required

The date/time that the post event occurred, if provided.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "description": "however-along-whether-knowledge-media", "eventId": "67266010", "eventType": "name-determine-wish-something-might", "messageId": "39956830", "timestamp": "1999-08-24T01:07:07.643890+00:00" }