Skip to content

Latest commit

 

History

History
93 lines (69 loc) · 3.94 KB

configure-slack.md

File metadata and controls

93 lines (69 loc) · 3.94 KB
Raw
canonical description keywords labels menuTitle title weight
Configure the Slack integration to connect alerts generated by Grafana Alerting
grafana
alerting
slack
integration
products
cloud
enterprise
oss
Slack
Configure Slack for Alerting
300

Configure Slack for Alerting

Use the Grafana Alerting - Slack integration to send Slack notifications when your alerts are firing.

There are two ways of integrating Slack into Grafana Alerting.

  1. Use a Slack API token

    Enable your app to access the Slack API. If, for example, you are interested in more granular control over permissions, or your project is expected to regularly scale, resulting in new channels being created, this is the best option.

  2. Use a Webhook URL

    Webhooks is the simpler way to post messages into Slack. Slack automatically creates a bot user with all the necessary permissions to post messages to one particular channel of your choice.

{{< admonition type="note" >}} Grafana Alerting only allows one Slack channel per contact point. {{< /admonition >}}

Before you begin

Slack API Token

If you are using a Slack API Token, complete the following steps.

  1. Follow steps 1 and 2 of the Slack API Quickstart.
  2. Add the chat:write.public scope to give your app the ability to post in all public channels without joining.
  3. In OAuth Tokens for Your Workspace, copy the Bot User OAuth Token.
  4. Open your Slack workplace.
  5. Right click the channel you want to receive notifications in.
  6. Click View channel details.
  7. Scroll down and copy the Channel ID. {{< admonition type="note" >}} While going through these steps, Slack may prompt you to Reinstall your app in order for the changes to take effect. {{< /admonition >}}

Webhook URL

If you are using a Webhook URL, follow steps 1 and 5 in the Slack API Quickstart.

{{< admonition type="note" >}} Make sure you copy the Slack app Webhook URL. You will need this when setting up your contact point integration in Grafana Alerting. {{< /admonition >}}

Procedure

To create your Slack integration in Grafana Alerting, complete the following steps.

  1. Navigate to Alerts&IRM -> Alerting -> Contact points.
  2. Click + Add contact point.
  3. Enter a contact point name.
  4. From the Integration list, select Slack.
  5. If you are using a Slack API token:
    • In the Recipient field, copy in the channel ID.
    • In the Token field, copy in the Bot User OAuth Token that starts with “xoxb-”.
  6. If you are using a Webhook URL, in the Webhook field, copy in your Slack app Webhook URL.
  7. Click Test to check that your integration works.
  8. Click Save contact point.

Next steps

To add the contact point and integration you created to your default notification policy, complete the following steps.

  1. Navigate to Alerts&IRM -> Alerting -> Notification policies.
  2. In the Default policy, click the ellipsis icon (…) and then Edit,
  3. Change the default policy to the contact point you created.
  4. Click Update default policy.

Note: If you have more than one contact point, add a new notification policy rather than edit the default one, so you can route specific alerts to Slack. For more information, refer to [Notification policies][nested-policy].

{{% docs/reference %}} [nested-policy]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-notification-policy#add-new-nested-policy"

[nested-policy]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/create-notification-policy#add-new-nested-policy" {{% /docs/reference %}}