Skip to main content
POST
/
events
Create Event
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>"
}
'
{
  "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.

​
conversationId
string
required

ID of the Conversation

Response

Returns a Event.

​
event
object
required