Skip to main content
Version: 8.3

Installation

Prerequisites

  • Ignition 8.3.0 or higher (Gateway)
  • The Alarm Notification module (com.inductiveautomation.alarm-notification) installed and running — this is a hard dependency; the Telegram module will fault without it
  • A Telegram Bot and its token, created via @BotFather (/newbot)
  • Outbound HTTPS access to api.telegram.org (port 443). No inbound connectivity is required.

Creating a Telegram Bot

Before installing the module, you need to create a Telegram bot:

  1. Open Telegram and search for @BotFather
  2. Start a conversation and send /newbot
  3. Follow the prompts to name your bot
  4. Save the Bot Token provided (format: 123456789:ABCdefGHIjklMNOpqrsTUVwxyz)
Keep Your Token Secret

The bot token grants full access to your bot. Never share it publicly or commit it to version control.

Download

Download Telegram Module

Installation Steps

  1. Log in to your Ignition Gateway web interface
  2. Navigate to Platform > System > Modules
  3. Click Install or Upgrade a Module
  4. Select the Telegram-Alarm-Notification.modl file
  5. Review and accept the license agreement
  6. The module installs and registers the Telegram Notification profile type with the Alarm Notification system
Gateway restart may be required

After installing or upgrading, a gateway restart may be needed for the acknowledgment callback poller to initialize correctly.

Verification

After installation:

  1. Verify the module appears in the modules list with Running status
  2. Navigate to Services > Alarming > Notification
  3. Click Create new Alarm Notification Profile...
  4. Verify that Telegram Notification appears as an available profile type

Network Requirements

Outbound (Ignition to Telegram)

The Ignition gateway must be able to reach the Telegram Bot API:

DestinationProtocolPort
api.telegram.orgHTTPS443
No Inbound Required

Unlike webhook-based integrations, this module receives acknowledgment callbacks by long-polling the Telegram getUpdates endpoint. No inbound firewall rules or webhook are required.

Getting User Chat IDs

Each user needs their Telegram chat id before they can be notified — see Configuration → Finding Your Chat ID.

Troubleshooting

IssueSolution
Module not appearingRestart the Ignition gateway and check gateway logs
"Telegram Notification" not in profile typesVerify the Alarm Notification module is running
Bot token errorVerify the token format and that the bot exists
Cannot reach Telegram APICheck firewall rules for outbound HTTPS to api.telegram.org