Mattermost

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

• Docs for the new version 2.0 can be found here.

User Guide

• Installation
• Tutorial: Rasa Basics
• Tutorial: Building Assistants
• Command Line Interface
• Architecture
• Messaging and Voice Channels
• Testing Your Assistant
• Validate Data
• Configuring the HTTP API
• Deploying Your Rasa Assistant
• Cloud Storage

NLU

• About
• Using NLU Only
• Training Data Format
• Language Support
• Choosing a Pipeline
• Components
• Entity Extraction

Core

• About
• Stories
• Domains
• Responses
• Actions
• Reminders and External Events
• Policies
• Slots
• Forms
• Retrieval Actions
• Interactive Learning
• Fallback Actions
• Knowledge Base Actions

Conversation Design

• Dialogue Elements
• Small Talk
• Completing Tasks
• Guiding Users

API Reference

• Action Server
• HTTP API
• Jupyter Notebooks
• Agent
• Custom NLU Components
• Rasa SDK
• Events
• Tracker
• Tracker Stores
• Event Brokers
• Lock Stores
• Training Data Importers
• Featurization of Conversations
• TensorFlow Configuration
• Migration Guide
• Rasa Open Source Change Log

Migrate from (beta)

• Dialogflow
• Wit.ai
• LUIS
• IBM Watson

Reference

• Glossary

Versions

viewing: 1.9.5

Mattermost

You first have to create a mattermost app to get credentials. Once you have them you can add these to your credentials.yml.

Getting Credentials

Mattermost now uses bot accounts for better security. So you can use their guide to create your bot to get your token required for the credentials.yml file.

For more information on creating a bot account please see Bot Creation.

For information on converting existing user account into bot account please see User Conversion.

How to set up the outgoing webhook:

1. To create the Mattermost outgoing webhook, login to your Mattermost team site and go to Main Menu > Integrations > Outgoing Webhooks.
2. Click Add outgoing webhook.
3. Fill out the details including the channel you want the bot in. You will need to ensure the trigger words section is set up with @yourbotname so that the bot doesn’t trigger on everything that is said.
4. The Content Type must be set to application/json.
5. Make sure trigger when is set to value first word matches a trigger word exactly.
6. The callback url needs to be either your localhost address for Rasa, or your ngrok url where you have your webhook running in Core or your public address, e.g. http://test.example.com/webhooks/mattermost/webhook or http://localhost:5005/webhooks/mattermost/webhook.

For more detailed steps, visit the Mattermost docs.

Running on Mattermost

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

rasa run

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

mattermost:
  url: "https://chat.example.com/api/v4"
  token: "xxxxx" #  the token for the bot account from creating the bot step.
  webhook_url: "https://server.example.com/webhooks/mattermost/webhook"

The endpoint for receiving Mattermost channel messages is /webhooks/mattermost/webhook, the same as webhook_url here. You should add this url also in the Mattermost outgoing webhook.

👋 I can help you get started with Rasa and answer your technical questions.