POST
/
v1
/
chat
/
events
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/chat/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "type": "<string>",
  "payload": {},
  "schedule": {
    "dateTime": "<string>",
    "delay": 123
  },
  "conversationId": "<string>",
  "userId": "<string>",
  "messageId": "<string>"
}'
{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>",
    "status": "pending",
    "failureReason": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

x-bot-id
string
header
required

Your bot ID.

Body

application/json

Event data

type
string
required

Type of the Event.

Maximum length: 200
payload
object
required

Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our API.

schedule
object

Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.

conversationId
string

ID of the Conversation to link the event to.

Required string length: 28 - 36
userId
string

ID of the User to link the event to.

Required string length: 28 - 36
messageId
string

ID of the Message to link the event to.

Required string length: 28 - 36

Response

201
application/json

Returns a Event object if creation succeeds. Returns an error otherwise

event
object
required

The event object represents an action or an occurrence.