Skip to content
Mattermost notification plugin for Redmine
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
app/views/settings Add Mattermost notification when wiki pages are updated (sync with sc… Feb 27, 2016
lib/redmine_mattermost Do not use symbols when referring to plugin configuration values Apr 8, 2018
Gemfile initial import Dec 30, 2015
LICENSE Prevent internal server error if empty custom field for channel (refs #… Jan 26, 2017

Mattermost chat plugin for Redmine

This plugin posts updates to issues in your Redmine installation to a Mattermost channel.

Redmine Supported versions: 2.0.x - 3.3.x.




From your Redmine plugins directory, clone this repository as redmine_mattermost (note the underscore!):

git clone redmine_mattermost

You will also need the httpclient dependency, which can be installed by running

bundle install

from the plugin directory.

Restart Redmine, and you should see the plugin show up in the Plugins page. Under the configuration options, set the Mattermost API URL to the URL for an Incoming WebHook integration in your Mattermost account and also set the Mattermost Channel to the channel's handle (be careful, this is not the channel's display name visible to users, you can find each channel's handle by navigating inside the channel and clicking the down-arrow and selecting view info). See also the next two sections for advanced and custom routing options.

Customized Routing

You can also route messages to different channels on a per-project basis. To do this, create a project custom field (Administration > Custom fields > Project) named Mattermost Channel. If no custom channel is defined for a project, the parent project will be checked (or the default will be used). To prevent all notifications from being sent for a project, set the custom channel to -.

For more information, see (see also next section for an easy configuration demonstration).

Screenshot Guided Configuration

Step 1: Create an Incoming Webhook in Mattermost (Account Settings > Integrations > Incoming Webhooks).


Step 2: Install this Redmine plugin for Mattermost.


Step 3: Configure this Redmine plugin for Mattermost. For per-project customized routing, leave the Mattermost Channel field empty and follow the next steps, otherwise all Redmine projects will post to the same Mattermost channel. Be careful when filling the channel field, you need to input the channel's handle, not the display name visible to users. You can find each channel's handle by going inside the channel and click the down-arrow and selecting view info.


Step 4: For per-project customized routing, first create the project custom field (Administration > Custom fields > Project).

step4a step4b

Step 5: For per-project customized routing, configure the Mattermost channel handle inside your Redmine project.



The source code is forked from Special thanks to the original author and contributors for making this awesome hook for Redmine. This fork is just refactored to use Mattermost-namespaced configuration options in order to use both hooks (Mattermost and Slack) in a Redmine installation.

You can’t perform that action at this time.