Skip to main content
Version: 8.3

Configuration

Alarm Notification Profile​

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

Profile Settings​

ParameterTypeRequiredDescription
NameTextYesName of the Alarm Notification Profile instance
DescriptionTextNoDescription of the Alarm Notification Profile instance
EnabledBooleanYesEnable/Disable the Alarm Notification Profile
Bot TokenSecretYesTelegram Bot token obtained from @BotFather, stored via Ignition's secret system
Audit ProfileReferenceNoOptional audit profile for logging notification events
Audit Profile reference

The Audit Profile field is a managed reference to an Ignition audit profile. While it is referenced, the target audit profile is delete-protected, and if that audit profile is renamed the reference is updated automatically.

Credentials​

The Bot Token is stored securely using Ignition's secret management system. To create the bot and obtain its token, see Installation → Creating a Telegram Bot.

Auditing​

When an audit profile is configured, the module writes one audit record per alarm event per notification. See Usage → Audit Logging for the fields each record stores.

User Contact Configuration​

For users to receive Telegram notifications, their contact information must include their Telegram chat id under the Telegram contact type (a custom contact type registered by this module). A user may have multiple Telegram contacts — all of them are messaged.

Finding Your Chat ID​

  1. Start a conversation with your bot in Telegram (you must /start or send at least one message to the bot first)
  2. Open this URL in a browser (replace <BOT_TOKEN> with your token): 
    https://api.telegram.org/bot<BOT_TOKEN>/getUpdates
  3. Find the chat.id value in the JSON response

Adding Contact Information​

  1. Navigate to Platform > Security > User Sources
  2. Open the user source's ⋮ menu, choose Manage Users, and 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 and use the group's chat id. Private chat ids are positive (e.g., 123456789); group chat ids are negative (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 configuration section
  3. Find the Telegram Notification properties category
  4. Set the Custom Telegram Message (CustomTelegramMessage) property

When a non-blank custom message is defined, it overrides the notification block's Message template for that specific alarm. This override applies to non-throttled (single-alarm) notifications only — throttled notifications always use the block's Throttled Message template.

Bot Permissions​

FeatureRequirement
Send messagesDefault (all bots can send)
Group messagesBot must be added to the group
Acknowledgment buttonsNo special permission needed
Group privacy mode does not affect acknowledgment

Telegram's bot privacy mode governs which regular chat messages a bot receives in groups. It does not affect this module's acknowledgment flow: acknowledgments arrive as callback_query events from inline-button taps, which are always delivered to the bot regardless of privacy mode.