Events is the base communication channel of the bot. Messages and payloads are a part of it, and it is the only way to receive or send information. Each event goes through the whole middleware chain (incoming or outgoing) before being received by either the bot or the user.
When Event Storage is enabled, you can use this API to query data about stored events. You can use multiple fields for your query, but at least one is required.
One or multiple fields to add to the search query
Additional parameters for the query, like ordering, number of rows, etc.
Return the state of the incoming queue. True if there are any events(messages) from the user waiting in the queue.
Current event in the action context, used to identify the queue
Register a new middleware globally. They are sorted based on their declared order each time a new one is registered.
The middleware definition to register
Removes the specified middleware from the chain. This is mostly used in case of a module being reloaded
Reply easily to any received event. It accepts an array of payloads and will send a complete event with each payloads. It is often paired with cms.renderElement to generate payload for a specific content type
The destination to identify the target
One or multiple payloads to send
Register the user feedback for a specific event. The type property is used to increment associated metrics
The ID of the first event of the conversation
The ID of the user
Either 1 or -1
For now, only supports qna & workflow
true if feedback was successfully saved
Send an event through the incoming or outgoing middleware chain
The event to send
When Event Storage is enabled, you can use this API to update an event. You can use multiple fields for your query, but at least one is required.
The ID of the event to update
Fields to update on the event
Generated using TypeDoc