How to use the Mattermost integration

Find the documentation about the deprecated versions (< v6.6.0) here.

1. Choose an integration

You have following integrations available:

When column changes then notify user/channel
When date arrives then notify user/channel
When item created then notify user/channel
When person assigned then notify user/channel
When status changes to something then notify user/channel
When status changes from something to something then notify user/channel
When subitem column changes then notify user/channel
When subitem status changes from something to something then notify user/channel
When update created then notify user/channel

You may also use the automation blocks Notify Mattermost User and Notify in Mattermost Channel in your own Automation templates.

2. Provide the Mattermost server credentials (first time)

Once you have chosen an automation template it opens up and you find a Mattermost icon in the second line. Clicking on it you will see +Add new account and maybe existing credentials. If you are using the Mattermost integration the first time, you have to click on +Add new account and then will be asked to provide information about the Mattermost server. Enter the following values:

Client ID of OAuth2 application
Client Secret of OAuth2 application
Base URL: the Mattermost server Url
Team: Team name

After submission of the data, you will be forwarded to the Mattermost server to login.

When successfully logged in, you may be asked to allow the integration to access your Mattermost user account. Once that done you can continue with selecting a user or channel, respectively.

You can create several Mattermost credentials and you may choose any of these for your automations. You can identify the credentials as <user>@<team>@<server url>.

Notes for the admin of the Mattermost server:

You must create an OAuth 2.0 Application. Please refer to the documentation. The Callback URL must be set to https://mmmi.nyxophyl.net/auth/callback. Once created, you can provide the Client ID and Client Secret of the application.

3. Fill in the information needed for the integration

All integrations need at least:

Message text to be sent
Channel or user as receiver of the message

Message text (notify)

Just click on notify and type the message that should be sent when a certain action is triggered. You can use the provided fields to get content from the board in the message.

Receiver

Each integration either sends the message to a user or a channel on the Mattemost server.

user: select one of the list of available user in your team. You may also choose yourself e.g. for testing purpose.
channel: you get a list of all channels which you are member of.

After providing all information of the integration and clicked on the button Create automation, the integration is ready.