Skip to main content

Documentation Index

Fetch the complete documentation index at: https://botpress.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

{
  "botId": "<string>",
  "conversationId": "<string>",
  "createdOn": "<Date>",
  "direction": "<EventDirection>",
  "id": "<string>",
  "integration": "<string>",
  "kb": {
    "included": [],
    "results": []
  },
  "messageId": "<string>",
  "payload": {},
  "preview": "<string>",
  "state": {},
  "tags": {
    "conversation": {},
    "message": {},
    "user": {}
  },
  "trigger": {
    "conversationId": "<string>",
    "eventName": "<string>",
    "flowId": "<string>",
    "integration": "<string>",
    "nodeId": "<string>",
    "userId": "<string>"
  },
  "type": "<string>",
  "userId": "<string>"
}
Whenever an event occurs during your bot’s execution—like a message being sent—you can access details about that event using the event object’s properties. The event object is available wherever you can use code in Botpress Studio. This includes: You can also access the event object within certain Cards’ configuration fields.
This documentation omits certain properties of the event object which exist to maintain internal functionality and aren’t useful for .
​
event
IncomingEvent
Information about the last incoming event in your bot’s execution.
Last modified on April 29, 2026