Integrate with Slack

This article highlights a new alerting feature that's natively available in Compass which is gradually rolling out to some Compass Cloud customers. It may not yet be visible or available on your site.

What does the integration offer?

With Compass’s ChatOps app for Slack, you can receive notifications for the alerts you care about, perform actions on the alerts, and manage some on-call work from your Slack channels — using Slack buttons or the /compass command.

You can add multiple Slack integrations to streamline alert notifications. For example, you can create an integration that notifies a Slack channel only about high-priority alerts, and another integration that notifies a different Slack channel about low-priority alerts.

How does the integration work?

Once your Compass site is connected to a Slack workspace, the ChatOps app can be added to any channel (even private ones) or direct messages where you’d like to receive alert notifications.

Compass product admins can set up Slack integrations for the site (to receive alerts that have no responder team added).
Team admins can set up Slack integrations for their teams (Slack notifications will be sent only for alerts on which their team is added as a responder).

Set up the integration

Before you set up the integration,

Make sure you’re the team admin or the Compass product admin
Connect your Slack workspace with your Compass site so you can use it for your integrations.
Make sure you’ve created the Slack channel or direct message to receive alert notifications.

Add a Slack integration

If you're on the Standard plan on Compass, you can only add this integration from your team’s Operations page.

Adding a Slack integration from your team’s Operations page will only let you send notifications on Slack for your team’s alerts.

To get Slack notifications for alerts that have no responder teams assigned, you’ll need access to the feature through Operations > Overview > General Configuration — this feature is available only on Premium plans.

Add Slack to your Compass site and connect a Slack workspace

Go to Apps > search for Slack.
Click on Get it now. The app will get installed in your Compass site
Click on Configure to connect your Slack workspace
Click on Connect to Slack and authorise the connection to your workspace (you need to be an Admin in your Slack workspace)
This completes the connection of the Slack workspace to Compass

Add Slack integration for your team

Click on Operations and from Overview, select the team for which you want to set up the Slack integration
Click on Integrations and select Slack from the list of integrations

Fill in some important details for your integration:

Integration name: Name your integration to easily find it later.
Responder team: The integration will send alerts for which the team you select is a responder.
Slack workspace: Select the Slack workspace where your channels exist. If you don’t see your workspace, make sure you have joined the connected workspace, then, send /connect on any Slack channel or direct message.
Slack channel or direct message: On selecting Select on Slack, you’ll be able to select a channel or direct message to receive alert notifications from this integration. Select Allow to confirm your choice and give Compass requested permissions on Slack.
Select Continue to save the integration. It will be ON by default.

Configure your integration as per your team’s preferences:

Edit integration settings to choose if alert actions show as buttons and to include additional alert fields in Slack messages.
Add filters to receive only certain alerts. No filters are added by default. Learn more about alert filters
Select the alert activity to get notified of on Slack. All alert activity is selected by default.

Slack commands for on-call actions

Log in to your Atlassian account

/connect

Acknowledge

/compass ack alert <1 2...>

Unacknowledge

/compass unack alert <1 2...>

Close

/compass close alert <1 2...>

Snooze

/compass snooze alert <1> for <m/h/d>

Add note

/compass add note <note> to alert <1 2...>

Add tags

/compass add tag <tag1, tag2...> to alert <1>

Add responder to alerts

/compass add responder <user's email> to alert <1 2...>

Acknowledge all open alerts

/compass ack all alerts

Acks up to 1000 alerts at a time that you have access to.

Close all open alerts

/compass close all alerts

Closes up to 1000 alerts at a time that you have access to.

Assign alerts to someone

/compass assign alert <1 2...> to <user's email>

Update alert priority

/compass update priority of alert <1> to <P1/P2/P3/P4/P5>

Execute a custom action

/compass execute <action> on alert <1 2...>

Create alert

/compass create alert <message> for <team1 team2...>

View an alert’s details

/compass alert <1>

View all alerts

/compass all alerts

View a team’s alerts

/compass all alerts of <team>

Escalate alerts

/compass escalate alert <1 2...> to <policy>

View all integrations

/compass all integrations

View all teams

/compass all teams

Search teams

/compass all teams <starts with/contains> <search term>

Turn on/off integration or policy

/compass turn on <integration/policy name>

/compass turn off <integration/policy name>

Assign on-call

/compass assign oncall to <user's email/me> for <team/schedule/all>

Optionally, add for <number of m/h/d> at the end.

Check who is on-call

/compass whoisoncall

Optionally, add for <schedule name> at the end.

Mute notifications for alerts and on-call

/compass mute notifications to me

/compass mute notifications to <user's email>

Optionally, add for <number of minutes> at the end.

Unmute notifications for alerts and on-call

/compass unmute notifications to me

/compass unmute notifications to <user's email>

Select the Compass to run your commands

/compass select site for commands

This command is only applicable to you if you have connected multiple Jira Service Management sites to your Slack workspace.

Get help on Slack

/compass help