createEvent

Creates a custom Event

POST/events

Header parameters

x-user-keystringrequired

Authentication Key

Request body

Event data

payloadobjectrequired

Payload is the content of the custom event.

conversationIdstringrequired

ID of the Conversation

Response

application/json

Returns a Event.

The response is of type createEventResponse · object.

eventobjectrequired

Request

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

Response

{
  "event": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "payload": {
      "key": null
    },
    "conversationId": "string",
    "userId": "string"
  }
}