Learn about the event types sent by the Flow REST API.
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
| Event Type | Description |
|---|---|
message | Called whenever Flow is sending reply message for a specific threadId |
history | Called whenever Flow is sending messaging history for a specific threadId |
threads | Called whenever Flow is sending a list of threads in the user's project |
trigger.events | Called whenever Flow is sending a list of events that can be triggered manually |
businessHours | Called whenever Flow is sending business hours information |
paused | Called when the AI engine has paused the operation for a specific threadId |
resumed | Called when the AI engine has resumed operation for a specific threadId |
isPaused | Called whenever Flow is sending bot status for a specific threadId |
inbound | Called whenever a user sends a message to Flow from the non-rest channel |
outbound | Called whenever AI engine sends a message to user from non-rest channel |
takeover | Called when the takeover action is executed |