Installation
Prerequisites
- Ignition 8.3.0 or higher
- A Telegram Bot created via @BotFather
- Network access to
api.telegram.org(HTTPS, port 443)
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 Config > Modules
- Click Install or Upgrade a Module
- Select the
Telegram-Alarm-Notification.modlfile - Review and accept the license agreement
- The module installs automatically and registers with the Alarm Notification system
Verification
After installation:
- Verify the module appears in the modules list with Running status
- Navigate to Config > 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 uses long-polling to receive acknowledgment callbacks. No inbound firewall rules are required.
Dependencies
The module requires the Alarm Notification module, which is included in all Ignition installations with the Alarming feature.
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 |