Configuration

Alarm Notification Profile

After installing the module, create an Alarm Notification Profile of type Telegram Notification.

Profile Settings

Parameter	Type	Required	Description
Name	Text	Yes	Name of the Alarm Notification Profile instance
Description	Text	No	Description of the Alarm Notification Profile instance
Enabled	Boolean	Yes	Enable/Disable the Alarm Notification Profile
Bot Token	Secret	Yes	Telegram Bot token obtained from @BotFather
Audit Profile	Dropdown	No	Optional audit profile for logging notifications

Credentials

The Bot Token is stored securely using Ignition's secret management system. To obtain a token:

1. Open Telegram and message @BotFather
2. Send /newbot and follow the prompts
3. Copy the token provided (format: 123456789:ABCdefGHIjklMNOpqrsTUVwxyz)

Auditing

When an audit profile is configured, the module logs:

• Notification send attempts
• Success/failure status
• Recipient information (Chat ID)
• Alarm source and event details

---

User Contact Configuration

For users to receive Telegram notifications, their contact information must include their Telegram Chat ID in the Telegram contact type.

Finding Your Chat ID

1. Start a conversation with your bot in Telegram
2. Send any message to the bot
3. Open this URL in a browser (replace <BOT_TOKEN> with your token):

   https://api.telegram.org/bot<BOT_TOKEN>/getUpdates

4. Find the chat.id value in the JSON response

Adding Contact Information

1. Navigate to Config > Security > Users, Roles
2. Edit the user
3. In the Contact Info section, add a contact of type Telegram
4. Enter the Chat ID (numeric value, e.g., 123456789)

Group Chats

For group notifications, add your bot to the group, then use the group's Chat ID (negative number, e.g., -987654321).

---

Per-Alarm Custom Message

The module supports per-alarm custom messages via the Extended Configuration of each alarm.

To configure a custom message for a specific alarm:

1. Open the alarm configuration in the Designer
2. Expand the Extended Config section
3. Find the Telegram Notification Properties category
4. Set the Custom Telegram Message property

When a custom message is defined, it overrides the notification block's message template for that specific alarm.

---

Bot Permissions

Ensure your bot has the necessary permissions:

Feature	Required Permission
Send messages	Default (all bots can send)
Group messages	Bot must be added to the group
Acknowledgment buttons	No special permission needed

Privacy Mode

By default, bots in groups only receive messages that mention them or start with /. For the acknowledgment feature to work, users must interact with the bot's inline buttons.