IncidentioAlertChannel Construct

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

Triggers and resolves alerts in Incident.io.

import { IncidentioAlertChannel } from 'checkly/constructs'

const incidentioChannel = new IncidentioAlertChannel('incidentio-channel-1', {
  name: 'ACME alerts',
  url: 'https://api.incident.io/v2/alert_events/checkly/xxxxx',
  apiKey: 'xxxxx45afe73'
})

import { IncidentioAlertChannel } from 'checkly/constructs'

const incidentioChannel = new IncidentioAlertChannel('incidentio-channel-1', {
  name: 'ACME alerts',
  url: 'https://api.incident.io/v2/alert_events/checkly/xxxxx',
  apiKey: 'xxxxx45afe73',
  sendRecovery: true,
  sendFailure: true,
  sendDegraded: true,
  sslExpiry: true,
  sslExpiryThreshold: 30,
})

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

Configuration

Incident.io Alert Channel Options

string

required

Friendly name to recognise the integration.

string

required

The target URL created by installing the Checkly integration in Incident.io.

string

required

The API key created by installing the Checkly integration in Incident.io.

string

The payload sent to the target URL when an alert is triggered. If this is not specified, we’ll send a default payload with a basic title, description, etc.We have handlebar helpers and variables available for building custom payloads.Here’s an example payload, using the default one that we provide:

new IncidentioAlertChannel('incidentio-channel-1', {
  name: 'ACME alerts',
  url: 'https://api.incident.io/v2/alert_events/checkly/xxxxx',
  apiKey: 'xxxxx45afe73',
  payload: `
    {
      "title": "{{ALERT_TITLE}}",
      "description": "{{ALERT_TITLE}} at {{STARTED_AT}} in {{RUN_LOCATION}} {{RESPONSE_TIME}}ms\\n\\n{{#if AI_ANALYSIS_CLASSIFICATION}}# AI Analysis\\n\\n{{AI_ANALYSIS_CLASSIFICATION}}\\n\\n{{{AI_ANALYSIS_ROOT_CAUSE}}}\\nRead full analysis: {{AI_ANALYSIS_LINK}}{{/if}}",
      "deduplication_key": "{{CHECK_ID}}",
      "metadata": {
        {{#if AI_ANALYSIS_CLASSIFICATION}}
        "ai_analysis_classification": "{{AI_ANALYSIS_CLASSIFICATION}}",
        "ai_analysis_root_cause": "{{{AI_ANALYSIS_ROOT_CAUSE}}}",
        "ai_analysis_link": "{{AI_ANALYSIS_LINK}}",
        {{/if}}
        "alertType": "{{ALERT_TYPE}}",
        "check_result_id": "{{CHECK_RESULT_ID}}",
        "resultLink": "{{RESULT_LINK}}"
      },
      {{#contains ALERT_TYPE "RECOVERY"}}
      "status": "resolved"
      {{else}}
      "status": "firing"
      {{/contains}}
    }
    `
})

General Alert Channel Options

These options are valid for all alert channels types.

boolean

Whether to send notifications when checks recover from a failed or degraded state. Default value is true.

boolean

Whether to send notifications when checks fail. Default value is true.

boolean

Whether to send notifications when checks become degraded. Default value is false.

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.

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.

Getting Started

DETECT

COMMUNICATE

Project & Configuration

Platform

IncidentioAlertChannel Construct

Configuration

Incident.io Alert Channel Options

General Alert Channel Options

​Configuration

​Incident.io Alert Channel Options

​General Alert Channel Options

Configuration

Incident.io Alert Channel Options

General Alert Channel Options