OpsgenieAlertChannel Construct

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

For general information about alerting, see our docs on the Opsgenie integration and alerting with Checkly.

Sends an alert notification to your Opsgenie account.

Basic Example

import { OpsgenieAlertChannel } from 'checkly/constructs'

const opsGenieChannel = new OpsgenieAlertChannel('opsgenie-channel-1', {
  name: 'My Ops Team',
  region: 'EU',
  priority: 'P1',
  apiKey: 'xxxx123abc'
})

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

Configuration

Opsgenie Alert Channel

Configure Opsgenie-specific settings:

Parameter	Type	Required	Default	Description
name	string	✅	-	Friendly name to recognise the integration
region	string	✅	-	Opsgenie location, either EU or US
priority	string	✅	-	Severity level, P1 to P5
apiKey	string	✅	-	API key for your Opsgenie account

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

Opsgenie Alert Channel Options

name · string · required

Friendly name to recognise the integration.

region · string · required

A string representing the Opsgenie location, either EU or US.

priority · string · required

A string representing the severity level, P1 to P5.

apiKey · string · required

An API key for your Opsgenie account.

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.