These docs are for version 1.x of Rasa Open Source. [Docs for the new version 2.0 can be found here.](/content/docs/rasa/index.html) ## User Guide - [Installation](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/installation/) - [Tutorial: Rasa Basics](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/rasa-tutorial/) - [Tutorial: Building Assistants](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/building-assistants/) - [Command Line Interface](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/command-line-interface/) - [Architecture](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/architecture/) - [Messaging and Voice Channels](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/messaging-and-voice-channels/) - [Testing Your Assistant](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/testing-your-assistant/) - [Setting up CI/CD](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/setting-up-ci-cd/) - [Validate Data](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/validate-files/) - [Configuring the HTTP API](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/configuring-http-api/) - [Deploying Your Rasa Assistant](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/how-to-deploy/) - [Cloud Storage](https://legacy-docs-v1.rasa.com/1.10.10/user-guide/cloud-storage/) ## NLU - [About](https://legacy-docs-v1.rasa.com/1.10.10/nlu/about/) - [Using NLU Only](https://legacy-docs-v1.rasa.com/1.10.10/nlu/using-nlu-only/) - [Training Data Format](https://legacy-docs-v1.rasa.com/1.10.10/nlu/training-data-format/) - [Language Support](https://legacy-docs-v1.rasa.com/1.10.10/nlu/language-support/) - [Choosing a Pipeline](https://legacy-docs-v1.rasa.com/1.10.10/nlu/choosing-a-pipeline/) - [Components](https://legacy-docs-v1.rasa.com/1.10.10/nlu/components/) - [Entity Extraction](https://legacy-docs-v1.rasa.com/1.10.10/nlu/entity-extraction/) ## Core - [About](https://legacy-docs-v1.rasa.com/1.10.10/core/about/) - [Stories](https://legacy-docs-v1.rasa.com/1.10.10/core/stories/) - [Domains](https://legacy-docs-v1.rasa.com/1.10.10/core/domains/) - [Responses](https://legacy-docs-v1.rasa.com/1.10.10/core/responses/) - [Actions](https://legacy-docs-v1.rasa.com/1.10.10/core/actions/) - [Reminders and External Events](https://legacy-docs-v1.rasa.com/1.10.10/core/reminders-and-external-events/) - [Policies](https://legacy-docs-v1.rasa.com/1.10.10/core/policies/) - [Slots](https://legacy-docs-v1.rasa.com/1.10.10/core/slots/) - [Forms](https://legacy-docs-v1.rasa.com/1.10.10/core/forms/) - [Retrieval Actions](https://legacy-docs-v1.rasa.com/1.10.10/core/retrieval-actions/) - [Interactive Learning](https://legacy-docs-v1.rasa.com/1.10.10/core/interactive-learning/) - [Fallback Actions](https://legacy-docs-v1.rasa.com/1.10.10/core/fallback-actions/) - [Knowledge Base Actions](https://legacy-docs-v1.rasa.com/1.10.10/core/knowledge-bases/) ## Conversation Design - [Dialogue Elements](https://legacy-docs-v1.rasa.com/1.10.10/dialogue-elements/dialogue-elements/) - [Small Talk](https://legacy-docs-v1.rasa.com/1.10.10/dialogue-elements/small-talk/) - [Completing Tasks](https://legacy-docs-v1.rasa.com/1.10.10/dialogue-elements/completing-tasks/) - [Guiding Users](https://legacy-docs-v1.rasa.com/1.10.10/dialogue-elements/guiding-users/) ## API Reference - [Action Server](https://legacy-docs-v1.rasa.com/1.10.10/api/action-server/) - [HTTP API](https://legacy-docs-v1.rasa.com/1.10.10/api/http-api/) - [Jupyter Notebooks](https://legacy-docs-v1.rasa.com/1.10.10/api/jupyter-notebooks/) - [Agent](https://legacy-docs-v1.rasa.com/1.10.10/api/agent/) - [Custom NLU Components](https://legacy-docs-v1.rasa.com/1.10.10/api/custom-nlu-components/) - [Rasa SDK](https://legacy-docs-v1.rasa.com/1.10.10/api/rasa-sdk/) - [Events](https://legacy-docs-v1.rasa.com/1.10.10/api/events/) - [Tracker](https://legacy-docs-v1.rasa.com/1.10.10/api/tracker/) - [Tracker Stores](https://legacy-docs-v1.rasa.com/1.10.10/api/tracker-stores/) - [Event Brokers](https://legacy-docs-v1.rasa.com/1.10.10/api/event-brokers/) - [Lock Stores](https://legacy-docs-v1.rasa.com/1.10.10/api/lock-stores/) - [Training Data Importers](https://legacy-docs-v1.rasa.com/1.10.10/api/training-data-importers/) - [Featurization of Conversations](https://legacy-docs-v1.rasa.com/1.10.10/api/core-featurization/) - [TensorFlow Configuration](https://legacy-docs-v1.rasa.com/1.10.10/api/tensorflow_usage/) - [Migration Guide](https://legacy-docs-v1.rasa.com/1.10.10/migration-guide/) - [Rasa Open Source Change Log](https://legacy-docs-v1.rasa.com/1.10.10/changelog/) ## Migrate from (beta) - [Dialogflow](https://legacy-docs-v1.rasa.com/1.10.10/migrate-from/google-dialogflow-to-rasa/) - [Wit.ai](https://legacy-docs-v1.rasa.com/1.10.10/migrate-from/facebook-wit-ai-to-rasa/) - [LUIS](https://legacy-docs-v1.rasa.com/1.10.10/migrate-from/microsoft-luis-to-rasa/) - [IBM Watson](https://legacy-docs-v1.rasa.com/1.10.10/migrate-from/ibm-watson-to-rasa/) ## Reference - [Glossary](https://legacy-docs-v1.rasa.com/1.10.10/glossary/) ## Versions viewing: 1.10.10 # Slack You first have to create a Slack app to get credentials. Once you have them you can add these to your `credentials.yml`. ## Getting Credentials **How to get the Slack credentials:** You need to set up a Slack app. > 1. To create the app go to [https://api.slack.com/apps](https://api.slack.com/apps) and click on **Create New App**. > 2. Activate the following features: > > - Interactivity & Shortcuts > Interactivity (if your bot uses any [interactive components](https://api.slack.com/reference/block-kit/interactive-components) , e.g. buttons) > > - Add your Rasa request URL `http://:/webhooks/slack/webhook`, replacing the host and port with the appropriate values that point to your Rasa X or Rasa Open Source deployment. > > - Event subscriptions > Subscribe to bot events: `message.channels`, `message.groups`, `message.im`, `message.mpim` > > - App Home > Always Show My Bot as Online > 3. Get the `Bot User OAuth Access Token` from the OAuth & Permissions page. Click `Install App to Workspace` and allow access to your workspace. You will need to provide this value in your credentials later in these instructions. It should start with `xoxb`. > 4. In the “OAuth & Permissions > Redirect URLs” enter the endpoint for receiving Slack messages. This is the same URL you entered above for Interactivity & Shortcuts - `http://:/webhooks/slack/webhook`. > 5. Go to the “Event Subscriptions” section, turn on the “Enable Events” and add the endpoint here also. For more detailed steps, visit the [Slack API docs](https://api.slack.com/incoming-webhooks). ## Running on Slack If you want to connect to the slack input channel using the run script, e.g. using: ``` rasa run ``` Do not forget to run the action server if this is required by your bot, e.g. using: ``` rasa run actions ``` You need to supply a `credentials.yml` with the following content: - The `slack_channel` can be a channel or an individual person that the bot should listen to for communications, in addition to the default behavior of listening for direct messages and app mentions, i.e. “@app_name”. To get the channel id, right click on the channel choose Copy Link and the id will be the last component in the URL. - Use the entry for `Bot User OAuth Access Token` in the “OAuth & Permissions” tab as your `slack_token`. It should start with `xoxb`. ``` slack: slack_token: "xoxb-286425452756-safjasdf7sl38KLls" slack_channel: "C011GR5D33F" slack_retry_reason_header: "x-slack-retry-reason" # Slack HTTP header name indicating reason that slack send retry request. This configuration is optional. slack_retry_number_header: "x-slack-retry-num" # Slack HTTP header name indicating the attempt number. This configuration is optional. errors_ignore_retry: None # Any error codes given by Slack included in this list will be ignored. Error codes are listed `here `_. ``` The endpoint for receiving slack messages is `http://localhost:5005/webhooks/slack/webhook`, replacing the host and port with the appropriate values. This is the URL you should add in the “OAuth & Permissions” section as well as the “Event Subscriptions.”