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:
- Open Telegram and search for @BotFather
- Start a conversation and send
/newbot - Follow the prompts to name your bot
- 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 ModuleInstallation Steps
- Log in to your Ignition Gateway web interface
- Navigate to Platform > System > Modules
- Click Install or Upgrade a Module
- Select the
Telegram-Alarm-Notification.modlfile - Review and accept the license agreement
- 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:
- Verify the module appears in the modules list with Running status
- Navigate to Services > Alarming > Notification
- Click Create new Alarm Notification Profile...
- 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:
| Destination | Protocol | Port |
|---|---|---|
api.telegram.org | HTTPS | 443 |
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
| Issue | Solution |
|---|---|
| Module not appearing | Restart the Ignition gateway and check gateway logs |
| "Telegram Notification" not in profile types | Verify the Alarm Notification module is running |
| Bot token error | Verify the token format and that the bot exists |
| Cannot reach Telegram API | Check firewall rules for outbound HTTPS to api.telegram.org |