Installation

Ignition 8.1 build

This page documents the Ignition 8.1 build of the Octopush Alarm Notification module. For the latest release, see the current (8.3) documentation.

Prerequisites

• Ignition 8.1.20 or higher
• The Alarm Notification module installed and running (hard dependency)
• An Octopush account with API credentials (API Login and API Key)
• Network access to api.octopush.com (HTTPS, port 443)
• For acknowledgement replies: public accessibility of your Ignition gateway callback endpoint

Download

Download Octopush Module

Installation Steps

1. Log in to your Ignition Gateway web interface
2. Navigate to Config > 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 Config > Alarming > Notification
3. Click Create new Alarm Notification Profile...
4. Verify that Octopush Notification appears as an available profile type

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

The module sends notifications to https://api.octopush.com/v1/public/multi-channel/send.

Inbound (Octopush Callbacks)

For acknowledgement functionality, your Ignition server must accept HTTP POST requests from Octopush at the module's callback servlet:

https://[IP or domain name]/system/octopush

The servlet only implements POST; all other HTTP methods return 501 Not Implemented.

No callback authentication in the 8.1 build

The 8.1 callback servlet does not authenticate inbound requests (no shared secret or auth header). Any client that can reach /system/octopush can post callback payloads. Restrict access at the network/reverse-proxy layer if this is a concern.

Firewall Configuration

If your Ignition server is behind a firewall, you need to:

1. Allow inbound HTTPS traffic to the callback endpoint from Octopush
2. Configure port forwarding or a reverse proxy if needed
3. Ensure the callback URL is publicly accessible

Dependencies

The module requires the Alarm Notification module (com.inductiveautomation.alarm-notification), which is included in Ignition installations with the Alarming feature. This is a required (hard) dependency; the module will fault if it is not present.

Troubleshooting

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