notice

This is documentation for Rasa Documentation v2.x, which is no longer actively maintained.
For up-to-date documentation, see the latest version (3.x).

Version: 2.x

RocketChat

Getting Credentials

How to set up Rocket.Chat:

  1. Create a user that will be used to post messages, and set its credentials at credentials file.

  2. Create a Rocket.Chat outgoing webhook by logging in as admin to Rocket.Chat and going to Administration > Integrations > New Integration.

  3. Select Outgoing Webhook.

  4. Set Event Trigger section to value Message Sent.

  5. Fill out the details, including the channel you want the bot listen to. Optionally, it is possible to set the Trigger Words section with @yourbotname so that the bot doesn't trigger on everything that is said.

  6. In the URLs section, set the URL to http://<host>:<port>/webhooks/rocketchat/webhook, replacing the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.

For more information on the Rocket.Chat Webhooks, see the Rocket.Chat Guide.

Running on RocketChat

Add the RocketChat credentials to your credentials.yml:

rocketchat:
user: "yourbotname"
password: "YOUR_PASSWORD"
server_url: "https://demo.rocket.chat"

Restart your Rasa X or Rasa Open Source server to make the new channel endpoint available for RocketChat to send messages to.