getMessage

Retrieves the Message object for a valid identifier.

GET/messages/{id}

Header parameters

x-user-keystringrequired

Authentication Key

Path parameters

idstringrequired

ID of the Message

Response

application/json

Returns a Message object if a valid identifier was provided

The response is of type getMessageResponse · object.

messageobjectrequired

The Message object represents a message in a Conversation for a specific User.

Request

curl --request GET \ \
  --url https://chat.botpress.cloud/your_default_webhook_url/messages/{id} \
  --header 'x-user-key: <x-user-key>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "message": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "payload": {
      "audioUrl": "string",
      "type": "audio"
    },
    "userId": "string",
    "conversationId": "string"
  }
}