Skip to content

feat: update slack app docs [ship] #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tnolet merged 1 commit into from
Jun 9, 2026
Merged

feat: update slack app docs [ship] #375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 30 additions & 15 deletions integrations/alerts/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Sending Alerts to Slack'
description: 'Configure the Slack integration to receive real-time alerts from Checkly'
sidebarTitle: 'Slack'
title: "Slack"
description: "Configure the Slack integration to receive real-time alerts from Checkly"
sidebarTitle: "Slack"
---

Setting up Slack as an alerting channel is simple:
Expand All @@ -11,18 +11,15 @@ Setting up Slack as an alerting channel is simple:

![Add a Slack WebHook URL to Checkly](/images/docs/images/alerting/slack.png)

You can add any **#public-channel-name**, **@username** for Direct Messages or a channel ID. For private channels, the Checkly
Slack app needs to be explicitly invited to that channel by tagging it like `@Checkly`.
You can add any **#public-channel-name**, **@username** for Direct Messages or a channel ID. For private channels, the Checkly Slack app needs to be explicitly invited to that channel by tagging it like `@Checkly`.

<Warning>
If you're using a free Slack workspace, be aware of [message limits](https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces).
Exceeding these limits may prevent new alerts from being delivered.
If you're using a free Slack workspace, be aware of [message limits](https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces). Exceeding these limits may prevent new alerts from being delivered.
</Warning>

## Example Failed Slack Alert

For each check and / or monitor, the Slack alert message contains key information, a possible root cause analysis and key
actions like rerunning the check.
For each check and / or monitor, the Slack alert message contains key information, a possible root cause analysis and key actions like rerunning the check.

![A slack message showing a failed alert](/images/docs/images/alerting/slack-failed-check.png)

Expand All @@ -34,19 +31,37 @@ From the recovered Slack message, you can see the timestamp as well as a link to

## Migrating from the deprecated Slack webhook alert channels

Checkly previously only had Slack webhook based alert channels. These types of webhooks have been deprecated by Slack and
are now also deprecated by Checkly. These webhook channels will keep working; we have not set a hard end-of-life date.
Checkly previously only had Slack webhook based alert channels. These types of webhooks have been deprecated by Slack and are now also deprecated by Checkly. These webhook channels will keep working; we have not set a hard end-of-life date.

You can recognize the deprecated channel in your alert channels list. It is named "Slack webhook" and has an alert icon.

![Deprecated Slack channel](/images/docs/images/alerting/slack-deprecated-channel.png)


To help you migrate from the old webhook based alert to the Slack app based alerts, we added a "Convert to Slack App alert channel"
button in each current webhook-based alert channel. Just click the button, confirm which channels you want to migrate or add new
ones, and click "Create Slack App alert channel".
To help you migrate from the old webhook based alert to the Slack app based alerts, we added a "Convert to Slack App alert channel" button in each current webhook-based alert channel. Just click the button, confirm which channels you want to migrate or add new ones, and click "Create Slack App alert channel".

![Convert to Slack App alert channel](/images/docs/images/alerting/slack-app-migration-wizard.png)

After this, you can safely delete the deprecated channel.

## Permissions

Checkly requests these Slack permissions for the Checkly Slack app to work within your workspace:

| Permission | Description |
| :-- | :-- |
| `app_mentions:read` | Detects @mentions to start Cloud Agents and respond to requests |
| `channels:history` | Reads previous messages in threads for extra context |
| `channels:join` | Automatically joins public channels when invited or requested. |
| `channels:read` | Accesses channel metadata (IDs and names) to post replies and updates |
| `chat:write` | Sends status updates and notifications on triggered actions like rerunning checks |
| `groups:history` | Reads previous messages in private channels for extra context |
| `groups:read` | Accesses private channel metadata to post responses |
| `im:history` | Accesses direct message history for extra context |
| `mpim:history` | Accesses group DM history for multi-participant conversations |
| `users:read` | Matches Slack users with Checkly accounts for permissions and secure access |
| `links:read` | Read links for allow-listed domains like [app.checklyhq.com](http://app.checklyhq.com) to provide rich context |
| `links:write` | Writes rich context for allow-listed domains like [app.checklyhq.com](http://app.checklyhq.com) |

## Privacy Policy

For information about how Checkly collects, uses, and protects your data, see our [Privacy Policy](https://checklyhq.com/privacy).
Loading