Skip to main content

Configuration

Alarm Notification Profile​

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

Creating the Alarm Notification Profile

Configure the Alarm Notification Profile with the following settings:

Alarm Notification Profile Settings

Main​

ParameterTypeDescription
Name *TextName of the Alarm Notification Profile instance
DescriptionTextDescription of the Alarm Notification Profile instance
Enabled *BooleanEnable/Disable the Alarm Notification Profile

Credentials​

ParameterTypeDescription
API Login *TextOctopush API login (found in your Octopush account settings)
API Key *TextAPI key provided by Octopush (found in your Octopush account settings)
Getting API Credentials

Log into your Octopush account at octopush.com and navigate to your API settings to obtain your API Login and API Key.

Auditing​

ParameterTypeDescription
Audit ProfileDropdownOptional audit profile to log all notification events

When an audit profile is configured, the module logs:

  • Notification send attempts
  • Success/failure status
  • Recipient information
  • Alarm source and event details

* Required fields

User Contact Configuration​

For users to receive Octopush notifications, their contact information must include phone numbers in the Octopush contact type.

  1. Navigate to Config > Security > Users, Roles
  2. Edit the user
  3. In the Contact Info section, add a contact of type Octopush
  4. Enter the phone number in international format (e.g., +33612345678)
Phone Number Format

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 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 Config section
  3. Find the Octopush Notification Properties category
  4. Set the Custom Message property

When a custom message is defined, it overrides the notification block's message template for that specific alarm.

Octopush Callback Configuration​

For acknowledgment functionality, configure webhooks in the Octopush admin interface.

Callback Types​

SMS TypeCallback TypeDescription
Text SMSIncoming messagesReceives SMS replies containing acknowledgment codes
Voice SMSDelivery receiptsReceives keypad input from voice calls

Configuration Steps​

  1. Log into your Octopush account
  2. Navigate to Settings > Webhooks (or Callbacks)
  3. Configure the callback URL:
https://[your-ignition-server]/system/octopush
  1. Set the HTTP method to POST
  2. Enable the callback for the appropriate message type

Octopush callback configuration page

Webhook Payload Format​

The module expects JSON payloads with acknowledgment codes in one of these formats:

For SMS replies:

{
  "text": "12345"
}

For Voice keypad input:

{
  "meta_data": {
    "pressed_keys_code": "12345"
  }
}
Important

Acknowledgment management requires the Ignition server to accept HTTP POST requests from Octopush servers. Ensure your firewall and network configuration allow this traffic.