Mattermost Integration
Mattermost is an open source, private cloud Slack-alternative platform. Opsgenie is an alert and notification management solution that is highly complementary to Mattermost.
What does Opsgenie offer for Mattermost users?
Opsgenie has a two-way integration with Mattermost. It's powerful and easy to configure: notifications of Opsgenie's robust alerts go right into a Mattermost channel. In turn, users acknowledge, close or assign these alerts from the channel, as easily as entering a command like /genie ack 12.
Add a Mattermost integration in Opsgenie, and in seconds combine Mattermost's easy-to-use team collaboration platform with Opsgenie's rich alert notification system and on-call rotation. Execute actions on the alert just by typing a /genie command into the chat.
Accomplish more in Opsgenie by entering simple commands to Mattermost channel. Using /genie commands, mute Opsgenie notifications, get alert details, view on-call schedules, etc.
"Require Matching a User" option is used to force matching Mattermost accounts with Opsgenie accounts. Chat user mapping section addresses this issue.
Configuring Mattermost Integration
- In Mattermost, enable incoming webhooks and slash commands from Main Menu > System Console > Integrations > Custom Integrations.
- To create Mattermost Incoming Webhook, go to Main Menu > Integrations > Incoming Webhooks and click Add Incoming Webhook.
- Fill in "Display Name" and "Description" fields, and select the channel or private group to receive webhook payloads, then click Save to create the webhook.
- After adding incoming webhook, a page appears. Copy the URL given on that page.
- Go to Opsgenie, and please create an Opsgenie account if you haven't done so already.
- Go to Opsgenie's Mattermost Integration page.
- Paste the URL copied from Mattermost to the "Mattermost URL" field.
- Copy the Request URL in order to use it while adding slash commands in Mattermost.
- Click Save Integration.
- Go to Mattermost and from Main Menu > Integrations > Slash Commands click Add Slash Command.
- Enter genie into the "Command Trigger Word" field.
- Paste the URL copied from Opsgenie to the "Request URL" field.
- Click Update.
Chat User Mapping
- "Require Matching a User" is used to force matching Mattermost accounts with Opsgenie accounts.
- Associate a Mattermost account to a Opsgenie account by using the /genie connect command.
- For more information, refer to Chat User Mapping.
- Chat user mapping flow:
- First, write /genie connect command. Click the "authenticate in opsgenie" link.
- In the opened tab, the link directs to the Opsgenie login page. Login and click Approve.
- Now, the Opsgenie account is connected to the Mattermost team.
Using /genie Command
Easily execute actions on Opsgenie alerts by entering a command with the tinyId of the alert into a Mattermost room. Note that single command can be executed on multiple alerts.
Use the alert command to create an alert in Opsgenie, right from a Mattermost channel.
Acknowledge Alert:
/genie ack [tinyID tinyID2..]
Examples:
/genie ack 1
/genie ack 1 2 3
Close Alert:
/genie close [tinyID tinyID2..]
Examples:
/genie close 1
/genie close 1 2 3
Add Note to Alert:
/genie note [note] to [tinyID tinyID2..]
Examples:
/genie note this is note to 1
/genie note this is note to 1 2 3
Add Tag to Alert:
/genie addtag [tag1,tag2,..] to [tinyID tinyID2..]
Examples:
/genie addtag high priority,important to 1
genie addtag high priority,important to 1 2 3
Acknowledge All Open Alerts:
/genie ackall
Close All Open Alerts:
/genie closeall
Assign Alert:
/genie assign [tinyID tinyID2..] to [user]
Examples:
/genie assign 1 to [email protected]
/genie assign 1 2 3 to [email protected]
Take Ownership of Alert:
/genie own [tinyID tinyID2..]
Examples:
/genie own 1
/genie own 1 2 3
Execute Action:
/genie exec [action] on [tinyID tinyID2..]
Examples:
/genie exec customAction on 1
/genie exec customAction on 1 2 3
Create Alert:
/genie alert [alert message] for [team1,team2,user1..]
Examples:
/genie alert this is alert message for [email protected]
/genie alert this is alert message for myTeam
/genie alert this is alert message for myTeam,[email protected]
Get Alert:
/genie get [tinyID]
Example:
/genie get 1
List Alerts:
Lists all open alerts.
/genie list
Lists all open alerts of specified team.
/genie list alerts of team1
List Integrations:
/genie list integrations
List Policies:
/genie list policies
List Teams :
/genie list teams
/genie list teams contains [search query]
/genie list teams starts with [search query]
Enable Integration/Policy:
/genie enable [name]
Example:
/genie enable policy
Disable Integration/Policy:
/genie disable [name]
Example:
/genie disable policy
Take On-call:
Takes on-call for the specified amount of time for the team or schedule. Default amount of time is 1h. If no schedule/team is specified, the user takes on-call for their team's schedule, or a single schedule they participate in.
/genie oncall [me/user] [h/m/d] for [team/schedule/all]
Sample uses are:
/genie oncall me 2h for weekend_schedule
/genie oncall [email protected] 1d for ops_team
/genie oncall me 2h for all
/genie oncall me 45m
/genie oncall me
Who is oncall:
Retrieves oncall user information from all schedules
/genie whoisoncall
Mute:
Mutes notifications for the user. Mutes for 5 minutes if not given.
/genie mute [me/username] [minutes(optional)]
Example:
/genie mute [email protected]
/genie mute [email protected] 15
Unmute:
Clears mute setting.
/genie unmute [me/username]
Example:
/genie unmute [email protected]
Connect:
Connect an Opsgenie account to a chat account. If a connection exists, the currently connected Opsgenie user is shown and a disconnect option is shown.
For more details see the Chat User Mapping documentation page.
/genie connect
Help:
/genie help
Updated over 5 years ago