Octopush
This page documents the Ignition 8.1 build of the Octopush Alarm Notification module. For the latest release and full feature set, see the current (8.3) documentation.
Overview
The Octopush module enables SMS and voice alarm notifications through the Octopush platform. It integrates with Ignition's Alarm Notification system as a custom notification profile type called Octopush Notification.
Messages are sent through the Octopush multi-channel API. The 8.1 build supports SMS and voice channels, expression-based message templating, per-alarm custom messages, and two-way acknowledgement (reply an SMS code, or press keys on a voice call) via an inbound callback servlet.
Features
- SMS Notifications - Send text messages to operators when alarms trigger (Octopush
smschannel) - Voice Notifications - Automated text-to-speech phone calls (Octopush
voicechannel) - Interactive Acknowledgement - Operators can acknowledge alarms by replying to an SMS with a code, or by entering the code on a voice call keypad
- Dynamic Message Templates - Expression-based message content with separate default and throttled templates
- Per-Alarm Custom Messages - Override the notification message at the alarm level via an extended alarm property
- Callback Servlet - Inbound callback endpoint (
/system/octopush) that receives acknowledgement replies - Test/Simulation Mode - Validate configuration without sending actual messages (Octopush
simulation_mode) - Audit Integration - Optionally log notification send attempts to a selectable Audit Profile
- License Management - Runs in trial mode until licensed; notifications stop when the trial expires (see Licensing)
Recipients are addressed using the standard Ignition SMS contact type. See Configuration.
Technical Specifications
| Specification | Value |
|---|---|
| Module ID | com.operametrix.ignition.octopush |
| Module Name | Octopush Alarm Notification |
| Module File | Octopush-Alarm-Notification.modl |
| Current Version | 1.0.2 |
| Minimum Ignition Version | 8.1.20 |
| Required Module | Alarm Notification (com.inductiveautomation.alarm-notification) - hard dependency |
| Scope | Gateway |
| License | Proprietary — © 2026 OperaMetrix SAS (paid, with trial) |
The module declares a required dependency on the Alarm Notification module (com.inductiveautomation.alarm-notification). If that module is not present and running, the Octopush module will fault.
Licensing
The Octopush Alarm Notification module is a paid module and participates in Ignition licensing. It runs in trial mode until licensed.
When the trial expires the profile stops dispatching: each notification is logged as Trial expired, notifications will not be sent. and marked done without being sent. The alarm pipeline sees no failure, so there is no retry and no fallback — alarms simply stop reaching recipients. The profile itself keeps running.
Activating a license resumes sending immediately, with no gateway restart. Activate a license or reset the trial from Config > System > Licensing. Licenses are available from the OperaMetrix marketplace.
Architecture
The module registers a custom Octopush Notification profile type in Ignition's Alarm Notification system. When an alarm triggers a notification block using this profile:
- The alarm event is received by the notification profile
- Contact information (phone numbers) is extracted from the roster using SMS contact entries
- Message expressions are evaluated with alarm context variables
- An acknowledgement code is generated when reply is enabled
- The notification is sent via the Octopush multi-channel API
- The inbound callback servlet at
/system/octopushhandles acknowledgement replies and acknowledges the alarm in Ignition