Event Properties

{
  "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.

Show child attributes

botId

string

required

The ID of the bot that experienced the event.

conversationId

string

The ID of the conversation that the event took place in.

createdOn

Date

required

The data and time when the event was created (in ISO 8601 format).

direction

EventDirection

required

The direction of the event, indicating whether the event was received by the bot or sent from the bot.Possible values:

'incoming': The event originated from the user and was received by the bot.
'outgoing': The event was generated by the bot and sent to the user.

string

required

The unique identifier for the event.

integration

string

The integration that the event occurred on.

object

Information about Knowledge Bases queried for the event.

Show child attributes

included

Studio.KnowledgeBase.KB[]

required

Array of Knowledge Bases queried for the event.

Since most of this object’s properties are for internal use by Botpress, we’ve omitted its deeper structure from this documentation.

results

Studio.KnowledgeBase.ContentResult[]

Array of Knowledge Base results consulted for this event.

Since most of this object’s properties are for internal use by Botpress, we’ve omitted its deeper structure from this documentation.

messageId

string

The unique identifier for the current event’s message.

payload

object

required

The payload for the current event.

preview

string

required

A representation of the event in plain text. If the event is text message, this property will contain the message itself.

state

EventState

required

Data related to the state of the event.

Since most of this object’s properties are for internal use by Botpress, we’ve omitted its deeper structure from this documentation.

Get Started

Guides

Reference