Skip to main content
POST
Post user message from a REST channel

Authorizations

token
string
query
required

A plaintext token to secure your server, specified at startup in the argument --auth-token thisismysecret

Path Parameters

rest_channel
enum<string>
required

The REST channel used for custom integrations. They provide a URL where you can post messages and either receive response messages directly, or asynchronously via a webhook.

Available options:
rest,
callback

Body

application/json

The user message payload

sender
string

The sender ID

Example:

"default"

message
string

The message text

Example:

"Hello!"

Response

The message was processed successfully

recipient_id
string

Id of the message receiver

Example:

"default"

text
string

Message

Example:

"Hello!"