createMessage

Creates a new Message

POST /messages

Create Message

cURL

curl --request POST \
  --url https://chat.botpress.cloud/{webhookUrl}/messages \
  --header 'Content-Type: application/json' \
  --header 'x-user-key: <x-user-key>' \
  --data '
{
  "payload": {
    "audioUrl": "<string>"
  },
  "conversationId": "<string>"
}
'

201

{
  "message": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "payload": {
      "audioUrl": "<string>"
    },
    "userId": "<string>",
    "conversationId": "<string>"
  }
}

Headers

x-user-key · string · required

Authentication Key

Body

application/json

Message data

payload · Audio · object · required

Payload is the content type of the message.

Audio

Card

Carousel

Choice

Dropdown

File

Image

Location

Markdown

Text

Video

Show child attributes

conversationId · string · required

ID of the Conversation

Response

201

application/json

Returns a Message.

message · object · required

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

Show child attributes