TelegramAlertChannel Construct

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

Sends alerts to a Telegram channel.

import { TelegramAlertChannel } from 'checkly/constructs'

const telegramChannel = new TelegramAlertChannel('my-telegramchannel-1', {
  name: 'My Telegram channel',
  apiKey: 'xxxxxx',
  chatId: 'xxxxxx'
})

import { TelegramAlertChannel } from 'checkly/constructs'

const telegramChannel = new TelegramAlertChannel('my-telegramchannel-1', {
  name: 'My Telegram channel',
  apiKey: 'xxxxxx',
  chatId: 'xxxxxx',
  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

Telegram Alert Channel Options

string

required

Friendly name to recognise the integration.

string

required

The API key associated with your Telegram bot.

string

required

The chat ID of the Telegram channel you want to send alerts to.

string

The message sent to the chat when an alert is triggered. If this is not specified, we’ll send a default payload with some basic information about the alert.We have handlebar helpers and variables available for building custom payloads.

new TelegramAlertChannel('my-telegramchannel-1', {
  name: 'My Telegram channel',
  apiKey: 'xxxxxx',
  chatId: 'xxxxxx',
  payload: `
    <b>{{ALERT_TITLE}}</b> at {{RUN_LOCATION}} ({{RESPONSE_TIME}}ms)
    {{#if AI_ANALYSIS_CLASSIFICATION}}
    AI Analysis: <i>{{AI_ANALYSIS_CLASSIFICATION}}</i>

    {{AI_ANALYSIS_ROOT_CAUSE}}
    <a href="{{AI_ANALYSIS_LINK}}">Read full analysis</a>
    {{/if}}

    Tags: {{#each TAGS}} <i><b>{{this}}</b></i> {{#unless @last}},{{/unless}} {{/each}}
    <a href="{{RESULT_LINK}}">View check result</a>
    `
})

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

TelegramAlertChannel Construct

Configuration

Telegram Alert Channel Options

General Alert Channel Options

​Configuration

​Telegram Alert Channel Options

​General Alert Channel Options

Configuration

Telegram Alert Channel Options

General Alert Channel Options