Configuration
This page documents the Ignition 8.1 build of the Octopush Alarm Notification module. For the latest release, see the current (8.3) documentation.
Alarm Notification Profile
After installing the module, create an Alarm Notification Profile of type Octopush Notification under Config > Alarming > Notification.
Configure the Alarm Notification Profile with the following settings.
General
| 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 |
Credentials
| Parameter | Type | Required | Description |
|---|---|---|---|
| API Login | Text | Yes | Octopush API login (found in your Octopush account settings) |
| API Key | Text | Yes | API key provided by Octopush (found in your Octopush account settings) |
Both credentials are stored as mandatory plain-text fields on the profile settings record. They are sent to the Octopush API as the api-login and api-key request headers.
In the 8.1 build the API Key is a standard text field, not an Ignition secret field. Treat the gateway configuration accordingly.
Log into your Octopush account at octopush.com and navigate to your API settings to obtain your API Login and API Key.
Auditing
| Parameter | Type | Required | Description |
|---|---|---|---|
| Audit Profile | Dropdown | No | Optional audit profile. If selected, alarm notification send attempts are stored to the audit system. |
When an audit profile is configured, the module logs each notification send attempt with a SUCCESS or FAILURE result, the recipient/user path, and the alarm event source. See Audit Logging.
User Contact Configuration
Recipients are addressed using the standard Ignition SMS contact type. The profile only supports the SMS contact type, so each user who should receive notifications must have an SMS contact entry containing their phone number.
- Navigate to Config > Security > Users, Roles
- Edit the user
- In the Contact Info section, add a contact of type SMS
- Enter the phone number in international format (e.g.,
+33612345678)
Phone numbers must be in international format with the country code prefix (e.g., +33 for France, +1 for USA).
Per-Alarm Custom Message
The module registers an extended alarm configuration property so a message can be overridden per alarm.
To configure a custom message for a specific alarm:
- Open the alarm configuration in the Designer
- Expand the Extended Config section
- Find the Octopush Notification Properties category
- Set the Custom Message property
When a custom message is defined, it overrides the notification block's Message template for that specific alarm. It is ignored when multiple events are throttled together (the throttled message template is used instead).
Octopush Callback Configuration
For acknowledgement functionality, configure a callback (webhook) in the Octopush admin interface pointing at the module's inbound servlet.
Configuration Steps
- Log into your Octopush account
- Navigate to the callback/webhook settings for incoming SMS replies and/or voice keypad input
- Configure the callback URL:
https://[your-ignition-server]/system/octopush
- Set the HTTP method to POST
- Enable the callback for the appropriate message type
Callback Payload Format
The servlet accepts a JSON POST body and extracts an acknowledgement code from one of two fields:
For SMS replies (the text field):
{
"text": "12345"
}
For voice keypad input (the pressed_keys_code field inside meta_data):
{
"meta_data": {
"pressed_keys_code": "12345"
}
}
The extracted value must parse as a number. If it matches a pending acknowledgement code, the associated alarm is acknowledged. Unrecognized or non-numeric payloads are accepted (HTTP 200) but ignored; malformed JSON returns HTTP 400.
The 8.1 callback servlet does not validate a shared secret or authentication header. Ensure your firewall / reverse proxy restricts who can reach /system/octopush.