Docs
/
/

List events

Returns a paginated list of events for the specified message.

List events

Returns a paginated list of events for the specified message.

Endpoint

GET/v1/messages/{message_id}/events

Rate limit

Tier 3

Path parameters

message_id
string

The ID of the message to fetch events for.

Query parameters

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

page_size
integer

The number of items per page (defaults to 50).

Returns

ListMessageEventsResponse

Returns a paginated list of delivery and engagement events for the specified message.

A list of message events.

__typename
string
Required

The typename of the schema.

data
object(any)

The data associated with the message event. Only present for some event types.

id
string
Required

The unique identifier for the message event.

inserted_at
string(date-time)
Required

Timestamp when the event was created.

recipient
2 possible types
Required

A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).

type
enum(string)
Required

The type of event that occurred.

message.archivedmessage.bouncedmessage.deliveredmessage.delivery_attemptedmessage.interactedmessage.link_clickedmessage.not_sentmessage.queuedmessage.readmessage.seenmessage.sentmessage.unarchivedmessage.undeliveredmessage.unreadmessage.unseen
page_info

Pagination information for a list of resources.

__typename
string

The typename of the schema.

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

page_size
integer

The number of items per page (defaults to 50).

New chat