Skip to main content
For general information about alerting, see our docs on SMS alerts and alerting with Checkly.
Use SMS Alert Channels to send SMS notifications to phone numbers when checks fail or recover.
import { SmsAlertChannel } from 'checkly/constructs'

const smsChannel = new SmsAlertChannel('sms-channel-1', {
  name: 'Ops on-call',
  phoneNumber: '+31061234567890',
})
If you need to reference existing alert channels that were created outside of your CLI project, use fromId().

Configuration

Configure SMS-specific settings:
ParameterTypeRequiredDefaultDescription
phoneNumberstring-Phone number in international format (e.g., +1234567890)
namestring-Friendly name for the SMS alert channel (e.g. “Tim’s phone”)

SMS Alert Channel Options

phoneNumber
string
required
Phone number to send SMS notifications to.Each SmsAlertChannel supports only one phone number. Phone numbers need to be in E.164 format.We only support phone numbers from certain countries and regions.
new SmsAlertChannel('sms-channel-1', {
  name: 'Ops on-call',
  phoneNumber: '+31061234567890',
})
name
string
Friendly name for the SMS alert channel.

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: "alerts@acme.com",
  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: "alerts@acme.com",
  sslExpiry: true,
  sslExpiryThreshold: 30, // Alert 30 days before expiry
})
Learn more about SSL alerts.