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.

Defaults to false in v2+ of the Svix SDKs, true in v1 or when manually making a request without specifying this parameter.

When true message payloads are included in the response.

Defaults to false in v2+ of the Svix SDKs, true in v1 or when manually making a request without specifying this parameter.

Response

channelsstring[] nullable

List of free-form identifiers that endpoints can filter by

deliverAtstring date-time nullable

eventIdstring nullable

Optional unique identifier for the message

eventTypestring required

The event type's name

idstring required

The Message's ID.

payloadobject required

tagsstring[] nullable

timestampstring date-time required

Example response

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

Changes

No recorded changes to this endpoint across all 5 revisions of this API.