Copy
{
"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>"
}
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 .Information about the last incoming event in your bot’s execution.
Show child attributes
Show child attributes
The ID of the bot that experienced the event.
The ID of the conversation that the event took place in.
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.
The unique identifier for the event.
The integration that the event occurred on.
Information about Knowledge Bases queried for the event.
Show child attributes
Show child attributes
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.
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.
The unique identifier for the current event’s message.
The payload for the current event.
A representation of the event in plain text. If the event is text message, this property will contain the message itself.
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.
The Trigger that sent the event.
Show child attributes
Show child attributes
The ID of the conversation associated with this Trigger.
The name of the event that the Trigger sent.
The ID of the Workflow containing the Trigger.
The integration associated with the Trigger.
The ID of the Node that contains the Trigger.
The ID of the user associated with this Trigger.
The type of the event.
The user ID associated with this event.