SlackAppAlertChannel Construct

Learn how to configure Slack alert channels with the Checkly CLI.

Slack App alert channels require the Checkly Slack App to be installed in your Slack workspace.

Sends alert notifications to Slack channels and as DMs.

Basic Example

import { SlackAppAlertChannel } from 'checkly/constructs'

const slackAppChannel = new SlackAppAlertChannel('slack-channel-1', {
  slackChannels: ['#ops', '@John Doe']
})

import { SlackAppAlertChannel } from 'checkly/constructs'

const slackAppChannel = new SlackAppAlertChannel('slack-channel-1', {
  slackChannels: ['#ops', '@John Doe'],
  sendRecovery: true,
  sendFailure: true,
  sendDegraded: true,
  sslExpiry: true,
  sslExpiryThreshold: 30,
})

If you need to reference existing alert channels that were created outside of your CLI project, use fromId().

Configuration

Slack Alert Channel Options

slackChannels · string[] · required

The Slack channels to alert. Can also include DM handles, e.g. “@John Doe”

new SlackAppAlertChannel('slack-channel-1', {
  slackChannels: ['#ops','@John Doe']
})

General Alert Channel Options

These options are valid for all alert channels types.

sendRecovery · boolean

Whether to send notifications when checks recover from a failed or degraded state. Default value is true.

sendFailure · boolean

Whether to send notifications when checks fail. Default value is true.

sendDegraded · boolean

Whether to send notifications when checks become degraded. Default value is false.

sslExpiry · boolean

Whether to send notifications when a SSL/TLS certificate is about to expire. Default value is false.

new EmailAlertChannel("email-channel-1", {
  address: "[e-mail]",
  sslExpiry: true,
  sslExpiryThreshold: 30, // Alert 30 days before expiry
})

Learn more about SSL alerts.

sslExpiryThreshold · number

Number of days before the SSL/TLS certificate expiry date to send notifications. Only relevant when sslExpiry is enabled. Default value is 30.

new EmailAlertChannel("email-channel-1", {
  address: "[e-mail]",
  sslExpiry: true,
  sslExpiryThreshold: 30, // Alert 30 days before expiry
})

Learn more about SSL alerts.