Skip to main content
POST
/
messages
Create Message
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>",
    "type": "audio"
  },
  "conversationId": "<string>"
}
'
{
  "message": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "payload": {
      "audioUrl": "<string>",
      "type": "audio"
    },
    "userId": "<string>",
    "conversationId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://botpress-ak-docs-20-document-updating-variables-from-outsid.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-user-key
string
required

Authentication Key

Body

application/json

Message data

​
payload
object
required

Payload is the content type of the message.

​
conversationId
string
required

ID of the Conversation

Response

Returns a Message.

​
message
object
required

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