createEvent

Creates a custom Event

POST /events

Create Event

cURL

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

201

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

Headers

x-user-key · string · required

Authentication Key

Body

application/json

Event data

payload · object · required

Payload is the content of the custom event.

Show child attributes

conversationId · string · required

ID of the Conversation

Response

201

application/json

Returns a Event.

event · object · required

Show child attributes