PhoneCallAlertChannel Construct

Learn how to configure phone call alert channels with the Checkly CLI.

For general information about alerting, see our docs on phone call alerts and alerting with Checkly.

Sends phone calls to the specified phone number.

Basic Example

import { PhoneCallAlertChannel } from 'checkly/constructs'

const callChannel = new PhoneCallAlertChannel('call-channel-1', {
  phoneNumber: '[phone]',
})

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

Configuration

Phone Call Alert Channel

Configure phone call-specific settings:

Parameter	Type	Required	Default	Description
phoneNumber	string	✅	-	Phone number in international format (e.g., [phone])
name	string	❌	-	Friendly name for the phone call alert channel

General Alert Channel

Configure common alert channel properties:

Property	Type	Required	Default	Description
sendRecovery	boolean	❌	true	Send notifications when checks recover
sendFailure	boolean	❌	true	Send notifications when checks fail
sendDegraded	boolean	❌	false	Send notifications when checks degrade
sslExpiry	boolean	❌	false	Send notifications for SSL certificate expiry
sslExpiryThreshold	number	❌	30	Days before SSL expiry to send notification

Phone Call Alert Channel Options

phoneNumber · string · required

Phone number to call.

Each PhoneCallAlertChannel 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 PhoneCallAlertChannel('call-channel-1', {
  phoneNumber: '[phone]',
})

name · string

Friendly name for the phone call 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: "[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.