Skip to content

docs: note that CLI validation fails for a Slack App channel without the app [RED-1289] #738

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

Open
sorccu wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Open

docs: note that CLI validation fails for a Slack App channel without the app [RED-1289] #738

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
2 changes: 1 addition & 1 deletion constructs/slack-app-alert-channel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ canonical: 'https://www.checklyhq.com/docs/constructs/slack-app-alert-channel/'
import AlertChannelOptionsText from '/snippets/alert-channel-options-text.mdx';

<Tip>
Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace.
Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. When it isn't connected to your Checkly account, the CLI commands that validate your project, such as `npx checkly validate`, `test` and `deploy`, fail with an error for each Slack App alert channel with Slack destinations.
</Tip>
Comment on lines 11 to 13

@hlenke hlenke Nov 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wording: Three changes:

  • "With Slack destinations" is hard to read. In #1585 the check fires only when slackChannels is non-empty, so name the prop.
  • Version-gated behavior goes in a <Note>. The <Tip> stays the cross-link.
  • Tell the reader how to fix it, as the CLI hint does.

Replace X.Y.Z with the CLI release that ships checkly/checkly-cli#1585.

Suggested change
<Tip>
Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace.
Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace. When it isn't connected to your Checkly account, the CLI commands that validate your project, such as `npx checkly validate`, `test` and `deploy`, fail with an error for each Slack App alert channel with Slack destinations.
</Tip>
<Tip>
Slack App alert channels require the [Checkly Slack App](/integrations/alerts/slack) to be installed in your Slack workspace.
</Tip>
<Note>
Since CLI vX.Y.Z, `npx checkly validate`, `test`, and `deploy` fail with an error for each `SlackAppAlertChannel` with a non-empty `slackChannels` list when the Checkly Slack App is not connected to your Checkly account. Connect it under [Account settings > Integrations](https://app.checklyhq.com/settings/account/integrations), or remove the channel.
</Note>


Sends alert notifications to Slack channels and as DMs.
Expand Down
Loading