Skip to main content
For general information about alerting, see our docs on the Pagerduty integration and alerting with Checkly.
Sends an alert notification to a specific service in your Pagerduty account.
import { PagerdutyAlertChannel } from 'checkly/constructs'

const pagerdutyChannel = new PagerdutyAlertChannel('pagerduty-channel-1', {
  account: 'ACME',
  serviceName: 'ACME products',
  serviceKey: '872b9b58ff4a9n06d0dl9f20487bbqwew'
})
If you need to reference existing alert channels that were created outside of your CLI project, use fromId().

Configuration

Configure Pagerduty-specific settings:
ParameterTypeRequiredDefaultDescription
accountstring-The name of your Pagerduty account
serviceNamestring-The name of your service in Pagerduty under which the alerts should be nested
serviceKeystring-The API key created by installing the Checkly integration in Pagerduty. Install the integration from our UI to get this.

Pagerduty Alert Channel Options

account
string
required
The name of your Pagerduty account.
serviceName
string
required
The name of your service defined in Pagerduty under which the alerts should be nested.
serviceKey
string
required
The API key created by installing the Checkly integration in Pagerduty. We advise you to install the Pagerduty alert channel first from the UI to grab the serviceKey.

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.