Email Messages

List events for an email message

Changed on

Lists events for a single message sorted oldest first by occurred_at asc, id asc. The legacy /v2/emails/{id}/events GET route is a backward-compatible alias.

For compatibility, each event carries the legacy customer-visible event_type (email.-prefixed), the additive canonical_event_type (email.-prefixed), and the deprecated type duplicate — whose value keeps the exact legacy format: the bare stored event name, never email.-prefixed. Gateway rejections render email.failed + canonical email.gw_reject; MTA expirations render email.bounced + canonical email.expired; every unchanged outcome carries identical event_type and canonical_event_type values (and type keeps the stored name).

get/email_messages/{email_id}/events

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_messages/{email_id}/events
  • Auth: HTTP bearer

Path parameters

email_idstring uuid required

Email message UUID.

Query parameters

page_sizeinteger

Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.

page_cursorstring

Opaque URL-safe Base64 cursor returned by a previous list response.

Response

Paginated list of message events.

Example response

{
  "data": [
    {
      "event_type": "email.delivered",
      "canonical_event_type": "email.delivered"
    }
  ]
}

Changes

  • 16bfa298dc71Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • info

      added to the // response property allOf list for the response status

    • info

      response property data/items/type deprecated

    • info

      removed the bounced enum value from the // response property for the response status

    • info

      removed the cancelled enum value from the // response property for the response status

    • info

      removed the clicked enum value from the // response property for the response status

    • info

      removed the complained enum value from the // response property for the response status

    • info

      removed the daily_limit_exceeded enum value from the // response property for the response status

    • info

      removed the deferred enum value from the // response property for the response status

    • info

      removed the delivered enum value from the // response property for the response status

    • info

      removed the failed enum value from the // response property for the response status

    • info

      removed the opened enum value from the // response property for the response status

    • info

      removed the queued enum value from the // response property for the response status

    • info

      removed the rejected enum value from the // response property for the response status

    • info

      removed the sandbox enum value from the // response property for the response status

    • info

      removed the scheduled enum value from the // response property for the response status

    • info

      removed the sending enum value from the // response property for the response status

    • info

      removed the sent enum value from the // response property for the response status

    • info

      removed the unsubscribed enum value from the // response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 9621f6123ebcRevision changes
    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status