Learn about the event types sent by the Flow REST API.
The following tables have a list of all the Flow-supported event types.
Note
We may introduce new event types at any time, so as you develop and maintain your code, do not limit your assumptions to only those listed here.
| Event Type | Description |
|---|---|
message | This event type is triggered whenever Flow sends a reply message for a specific threadId |
history | This event type is triggered whenever Flow sends messaging history for a specific threadId |
threads | This event type is triggered whenever Flow sends a list of threads in the user’s project |
trigger.events | This event type is triggered whenever Flow sends a list of events that can be triggered manually |
businessHours | This event type is triggered whenever Flow sends business hours information |
paused | This event type is triggered when the AI engine has paused the operation for a specific threadId |
resumed | This event type is triggered when the AI engine has resumed operation for a specific threadId |
isPaused | This event type is triggered whenever Flow sends a bot status for a specific threadId |
inbound | This event type is triggered whenever a user sends a message to Flow from a non-REST channel |
outbound | This event type is triggered whenever the AI engine sends a message to the user from a non-REST channel |
takeover | This event type is triggered when the takeover action is executed |