sentry-mattermost-plugin 0.1.1

Plugin for Sentry which allows sending notifications to a self-hosted Mattermost instance.

sentry-mattermost-plugin

A Sentry plugin that sends issue notifications to a self-hosted Mattermost instance via the Mattermost Bot API.

Official Repo seems to be outdated. So here's alternative.

Inspired by sentry-telegram.

Requirements

• Sentry (self-hosted)
• Python 3.8+
• A Mattermost Bot account with a token

Installation

Install the package into Sentry's Python environment:

pip install sentry-mattermost-plugin

Or in development mode from source:

git clone https://github.com/masstek/sentry-mattermost-plugin
cd sentry-mattermost
pip install -e .

Restart Sentry after installation so the entry point is picked up.

Configuration

1. In Sentry, go to Project Settings → Legacy Integrations.
2. Find Mattermost Notifications and click Configure plugin.
3. Fill in the fields:

Field	Description
Mattermost Host	Base URL of your Mattermost instance, e.g. https://mattermost.company.com
Bot Token	Access token for the Mattermost Bot account
Channel IDs	One channel ID per line. Find IDs via Mattermost → channel name → View Info
Message Template	Optional. Supports {project_name}, {url}, {title}, {message}, {tag[key]}
Verify SSL Certificate	Uncheck if your instance uses a self-signed certificate

4. Click Save changes.
5. Click Test Plugin to send a test notification to all configured channels.

Creating a Mattermost Bot

1. In Mattermost go to Main Menu → Integrations → Bot Accounts.
2. Click Add Bot Account, give it a name, and save.
3. Copy the generated token — this is the Bot Token for the plugin.
4. Add the bot to the channels it needs to post in.

Message Template

The default template is:

*[Sentry]* {project_name} | {title}
{url}
{message}

Available variables:

Variable	Description
{project_name}	Sentry project name
{url}	Link to the Sentry issue
{title}	Error title (truncated to 500 characters)
{message}	Error message
{tag[key]}	Value of a Sentry tag by key, e.g. {tag[environment]}. Returns [NA] if absent.

Mattermost Markdown is supported in the template.

Running Tests

pip install pytest pytest-cov requests django
pytest tests/ --cov=sentry_mattermost_plugin --cov-report=term-missing

No Sentry installation is required to run the tests.

License

MIT