Skip to main content

Documentation Index

Fetch the complete documentation index at: https://checklyhq.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

For general information about alerting, see our docs on email alerts and alerting with Checkly.
Use Email Alert Channels to send email notifications when checks fail or recover. 
import { EmailAlertChannel } from "checkly/constructs"

const emailChannel = new EmailAlertChannel("email-channel-1", {
  address: "alerts@acme.com",
})
If you need to reference existing alert channels that were created outside of your CLI project, use fromId().

​
Configuration

​
Email Alert Channel Options

​
address
string
required
Email address to send notifications to. Each EmailAlertChannel supports only one email address, do not use multiple addresses separated by a comma.

​
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.