createEvent

Creates a new Event. When creating a new Event, the required tags must be provided. See the specific integration for more details.

POST /v1/chat/events

Try it

cURL

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: <x-bot-id>' \
  --data '
{
  "type": "<string>",
  "payload": {},
  "schedule": {
    "dateTime": "<string>",
    "delay": 123
  },
  "conversationId": "<string>",
  "userId": "<string>",
  "workflowId": "<string>",
  "messageId": "<string>"
}
'

201

{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "status": "pending",
    "failureReason": "<string>",
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Body

application/json

Event data

type · string · required

Type of the Event.

Maximum string 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.

Show child attributes

schedule. dateTime · string

When the Event will be sent, in the ISO 8601 format

Required string length: 24 - 28

schedule. delay · number

Delay in milliseconds before sending the Event

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

workflowId · string

ID of the Workflow 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.

Show child attributes

event. id · string · required

Id of the Event

Required string length: 28 - 36

event. createdAt · string<date-time> · required

Creation date of the Event in ISO 8601 format

event. type · string · required

Type of the Event.

Maximum string length: 200

event. 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.

event. status · enum<string> · required

Available options: pending, processed, ignored, failed, scheduled, canceled

event. failureReason · string | null · required

Reason why the event failed to be processed

Maximum string length: 2000

event. conversationId · string

ID of the Conversation to link the event to.

Required string length: 28 - 36

event. userId · string

ID of the User to link the event to.

Required string length: 28 - 36

event. messageId · string

ID of the Message to link the event to.

Required string length: 28 - 36