Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Message

Get Message

Get a message by its ID or eventID.

get/api/v1/app/{app_id}/msg/{msg_id}

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

msg_idstring required

The Message's ID or UID.

Example:unique-identifier

The Message's ID or UID.

Query parameters

with_contentboolean

When true message payloads are included in the response.

When true message payloads are included in the response.

Response

eventIdstring nullable

Optional unique identifier for the message

eventTypestring required

The event type's name

payloadobject required
channelsstring[] nullable

List of free-form identifiers that endpoints can filter by

idstring required

The Message's ID.

timestampstring date-time required
tagsstring[] nullable
deliverAtstring date-time nullable

Example response

{
  "eventId": "unique-identifier",
  "eventType": "user.signup",
  "payload": {
    "type": "user.created",
    "email": "test@example.com",
    "username": "test_user"
  },
  "channels": [
    "project_123",
    "group_2"
  ],
  "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "tags": [
    "project_1337"
  ]
}