Slack¶

SUGGEST EDITS

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.

To create the app go to: https://api.slack.com/apps and click on “Create New App”.

Activate the following features: interactive components, event subscriptions, bot users, permissions (for basic functionality you should subscribe to the message.channel, message.groups, message.im and message.mpim events)

The slack_channel is the target your bot posts to. This can be a channel or an individual person. You can leave out the argument to post DMs to the bot.

Use the entry for Bot User OAuth Access Token in the “OAuth & Permissions” tab as your slack_token. It should start with xoxob.

For more detailed steps, visit the Slack API docs.

Running on Slack¶

If you want to connect to the slack input channel using the run script, e.g. using:

rasa run

you need to supply a credentials.yml with the following content:

slack:
  slack_token: "xoxb-286425452756-safjasdf7sl38KLls"
  slack_channel: "#my_channel"
  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 <https://api.slack.com/events-api#errors>`_.

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.