Events

These docs are for version 1.x of Rasa Open Source.

User Guide

NLU

Core

Conversation Design

API Reference

Migrate from (beta)

Reference

Events

Conversations in Rasa are represented as a sequence of events. This page lists the event types defined in Rasa Core.

Note: If you are using the Rasa SDK to write custom actions in python, you need to import the events from rasa_sdk.events, not from rasa.core.events. If you are writing actions in another language, your events should be formatted like the JSON objects on this page.

General Purpose Events

Automatically tracked events

Examples

Set a Slot

Short: Event to set a slot on a tracker
JSON:

{ "event": "slot", "name": "departure_airport", "value": "BER" }

Class: rasa.core.events.SlotSet

Restart a conversation

Short: Resets anything logged on the tracker.
JSON:

{ "event": "restart" }

Class: rasa.core.events.Restarted

Reset all Slots

Short: Resets all the slots of a conversation.
JSON:

{ "event": "reset_slots" }

Class: rasa.core.events.AllSlotsReset

Schedule a reminder

Short: Schedule an intent to be triggered in the future.
JSON:

{ "event": "reminder", "intent": "my_intent", "entities": {"entity1": "value1", "entity2": "value2"}, "date_time": "2018-09-03T11:41:10.128172", "name": "my_reminder", "kill_on_user_msg": true }

Class: rasa.core.events.ReminderScheduled

Cancel a reminder

Short: Cancel one or more reminders.
JSON:

{ "event": "cancel_reminder", "name": "my_reminder", "intent": "my_intent", "entities": [ {"entity": "entity1", "value": "value1"}, {"entity": "entity2", "value": "value2"} ], "date_time": "2018-09-03T11:41:10.128172" }

Class: rasa.core.events.ReminderCancelled

Pause a conversation

Short: Stops the bot from responding to messages.
JSON:

{ "event": "pause" }

Class: rasa.core.events.ConversationPaused

Resume a conversation

Short: Resumes a previously paused conversation.
JSON:

{ "event": "resume" }

Class: rasa.core.events.ConversationResumed

Force a followup action

Short: Instead of predicting the next action, force the next action to be a fixed one.
JSON:

{ "event": "followup", "name": "my_action" }

Class: rasa.core.events.FollowupAction