Chat API
- Introduction
- Endpoints
- GETgetConversation
- DELdeleteConversation
- POSTcreateConversation
- GETlistConversations
- POSTgetOrCreateConversation
- GETlistenConversation
- GETlistMessages
- GETgetMessage
- DELdeleteMessage
- POSTcreateMessage
- POSTaddParticipant
- GETlistParticipants
- DELremoveParticipant
- GETgetParticipant
- GETgetUser
- PUTupdateUser
- DELdeleteUser
- POSTcreateUser
- POSTgetOrCreateUser
- GETgetEvent
- POSTcreateEvent
- GET
Admin API
- Getting started
- Concepts
- Endpoints
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
createEvent
Creates a custom Event
POST
/
events
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
Authentication Key
Body
application/json
Event data
The body is of type object
.
Response
201
application/json
Returns a [Event](#schema_event).
The response is of type object
.
Was this page helpful?
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>"
}
}