Installation

Prerequisites

• Ignition 8.3.0 or higher
• The Alarm Notification module (com.inductiveautomation.alarm-notification) installed and running — a hard dependency; without it the Octopush module faults and its profile type is unavailable. It ships with any Ignition install that includes the Alarming feature.
• An Octopush account with API credentials (API Login and API Key)
• Outbound HTTPS access to https://api.octopush.com (port 443)
• For two-way acknowledgement or delivery auditing: inbound HTTP POST reachability at /system/octopush from Octopush servers (only required if reply-acknowledgement or delivery auditing is used)

Download

Download Octopush Module

Installation Steps

1. Log in to your Ignition Gateway web interface
2. Navigate to Platform > System > Modules
3. Click Install or Upgrade a Module
4. Select the Octopush-Alarm-Notification.modl file
5. Review and accept the license agreement
6. The module installs and registers the Octopush Notification profile type with the Alarm Notification system

Verification

After installation:

1. Verify the module appears in the modules list with Running status
2. Navigate to Services > Alarming > Notification
3. Click Create new Alarm Notification Profile...
4. Verify that Octopush Notification appears as an available profile type

Upgrading from Ignition 8.1

The notification profile must be re-created. There is no automatic importer: the 8.1 build stored profile settings as a PersistentRecord row in the gateway's internal database, and the 8.3 build stores them as a config resource. The 8.1 row is left in place and ignored.

Write down your API Login and API Key before upgrading, then create a fresh Octopush Notification profile at Services > Alarming > Notification.

Schema changes

8.1	8.3
APILogin — plain text	Unchanged
APIKey — plain text field	Secret field — encrypted at rest, and can reference a Secret Provider entry
AuditProfileId — numeric reference	auditProfileName — referenced by name
—	disableReplyCallback — new
—	callbackSecret — new, secret field (see Callback Authentication)

Alarm-level properties gained Voice Gender, Voice Language, and Voice Repeat. These are additive — existing alarms keep working and fall back to defaults.

Network Requirements

Outbound (Ignition to Octopush)

The Ignition gateway must be able to reach the Octopush API:

Destination	Protocol	Port
api.octopush.com	HTTPS	443

Inbound (Octopush Callbacks)

Inbound reachability is only required when using two-way reply acknowledgement or delivery auditing. In those cases, your Ignition server must accept HTTP POST requests from Octopush servers at the callback servlet.

The callback endpoint is:

http(s)://[IP or domain name]/system/octopush

Context path variant

Depending on how the gateway is deployed, the servlet may also be reachable under the /main context path, i.e. /main/system/octopush.

External exposure

The callback is served over plain HTTP unless you terminate TLS in front of Ignition. Octopush can send the X-Ignition-Octopush-Token custom header, so callback authentication works end to end — see Configuration → Callback Authentication.

Firewall Configuration

If your Ignition server is behind a firewall and you use acknowledgement or delivery auditing, you need to:

1. Allow inbound HTTP POST traffic from Octopush servers to /system/octopush
2. Configure port forwarding or a reverse proxy if needed
3. Ensure the callback URL is publicly reachable

Troubleshooting

Issue	Solution
Module faults on startup	Verify the Alarm Notification module is installed and running
Module not appearing	Restart the Ignition gateway and check gateway logs
"Octopush Notification" not in profile types	Verify the Alarm Notification module is running
License warnings	Check trial status in module details