List Events

GET/print-mail/v1/events

Retrieve a paginated list of Events.

Query ParametersExpand Collapse

limit: optional number

formatint32

skip: optional number

formatint32

type: optional array of "letter.created" or "letter.updated" or "postcard.created" or 18 more

An optional list of event types to filter the results by.

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"

ReturnsExpand Collapse

data: array of 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" or "letter.updated" or "postcard.created" or 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: optional map[unknown]

The data of the resource associated with this event.

updatedFields: optional map[unknown]

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

limit: number

formatint32

object: "list"

skip: number

formatint32

totalCount: number

formatint32

List Events

curl https://api.postgrid.com/print-mail/v1/events \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "event_r1nfP4xAacyqMYtt7PeyFD",
      "object": "event",
      "live": false,
      "type": "letter.created",
      "data": {
        "id": "letter_rqfnwvzq5TUsYR2r6L9V8X",
        "object": "letter",
        "live": false,
        "description": "letter test 2"
      },
      "createdAt": "2021-04-02T02:06:55.086Z"
    }
  ]
}

Returns Examples

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "event_r1nfP4xAacyqMYtt7PeyFD",
      "object": "event",
      "live": false,
      "type": "letter.created",
      "data": {
        "id": "letter_rqfnwvzq5TUsYR2r6L9V8X",
        "object": "letter",
        "live": false,
        "description": "letter test 2"
      },
      "createdAt": "2021-04-02T02:06:55.086Z"
    }
  ]
}