Static Documentation

Mattermost Channel

Version latest · Updated 2026-09-12
Interactive docs View on GitHub

Mattermost channel#

Mattermost is an outgoing notification channel.

IncidentRelay supports two Mattermost delivery styles:

  • Incoming webhook mode.
  • Bot API mode with interactive buttons and message updates.

Bot API mode is recommended when you want ACK/Resolve/Shelve actions.

Incoming webhook mode#

Use this mode when you only need one-way notifications.

Typical config:

{
  "webhook_url": "https://mattermost.example.com/hooks/..."
}

Bot API mode#

Use this mode for:

  • Acknowledge button;
  • Resolve button;
  • Shelve 1h / Unshelve buttons;
  • message updates after ACK/Resolve/Shelve;
  • better user attribution.

Typical config fields:

{
  "base_url": "https://mattermost.example.com",
  "bot_token": "...",
  "channel_id": "...",
  "callback_secret": "change-me"
}

Set [server] public_base_url correctly, because buttons need callback URLs that Mattermost can reach.

Mattermost user ID#

A user can have a Mattermost user ID in their profile. This is useful for attribution when the user clicks ACK/Resolve/Shelve buttons.

Test button#

The channel test sends a test notification through the configured Mattermost channel. It does not prove that a real alert route will match or that severity filters will allow the alert.

Troubleshooting#

Check:

  • Channel is enabled.
  • Channel is attached to the matched route.
  • Severity filter allows the alert severity.
  • Bot token or webhook URL is correct.
  • public_base_url is reachable from Mattermost for buttons.

Shelving#

Mattermost Bot API messages support signed Shelve 1h and Unshelve actions. Incoming webhook mode remains one-way. The Mattermost user ID must resolve to an IncidentRelay user with responder access to the AlertGroup team. See Alert shelving.