Skip to end of metadata
Go to start of metadata


SMS notifications can also be sent with the Twilio Alarm Notification module. This does not require a cellular modem, but the Gateway must have Internet access, and a Twilio account with SMS capabilities must be created (www.twilio.com). Once created, the account must be defined in Ignition.

Note: The Twilio module is dependent on the Alarm Notification module. You must have both modules installed to send alarms.

Define a Twilio Account

  1. Navigate to the Config section of the Gateway Webpage.
  2. Scroll down and choose Twilio > Accounts



  3. On the Twilio Accounts page, click the Create new Twilio Account link.



  4. Provide a Name for the account as well as the Twilio Account Sid, and Twilio Auth Token.
    Both the Account SID and Auth Token can be retrieved from the Account Settings menu in Twilio. 
  5. If desired, provide the Public Hostname. This is the hostname or IP address that inbound requests will be forwarded. If the users should be able to acknowledge alarms by responding to the SMS messages, then this property should list a publicly reachable hostname or IP address. 
  6. Click the Create New Twilio Account button.

Once the account has been defined, a Twilio SMS notification profile must also be created. 


On this page ...


KBLogo


AirLink LS300 Setup Guide


KBLogo


AirLink RV50 Setup Guide



Twillio Accounts Settings

The following table describes the settings on the Twilio Accounts page.

SettingDescription
Twilio
NameName for the Twilio Account.
Twilio Account SidTwilio account Sid: retrieve from the Account Settings menu in Twilio. (Required.)
Twilio Auth TokenTwilio auth token: retrieve from the Account Settings menu in Twilio. (Required.)
Inbound
Public HostnameThe publicly reachable hostname or IP address that is configured to forward inbound requests to this Ignition gateway. This must be configured in order to receive inbound SMS. Leave blank if inbound SMS are not needed.
Public PortThe port on the Public Hostname to make the connection to. Default is 80.
Backup Public HostnameThe publicly reachable hostname or IP address that is used when the backup of a redundant pair becomes active.
Backup Public PortThe port on the Public Hostname to make the connection to that is used when the backup of a redundant pair becomes active. Default is 80.
HTTPS EnabledTrue if the callback URL should use HTTPS instead of HTTP.  Default is false.
Inbound Validation EnabledCryptographically validate that inbound requests over HTTPS are from Twilio. Default is false.


Create a Twilio SMS Notification Profile

  1. Go to the Config section of the Gateway Webpage.
  2. Scrolll down and select Alarming > Notification from the menu on the left side. 



  3. Click on the Create new Alarm Notification Profile link. 
  4. Select the Twilio SMS Notification profile type, and click Next.



  5. Provide a name for the profile, and select a Twilio Account from the dropdown.
  6. Set the other profile settings as desired. (See table below for a description of all settings.) 
  7. Click Create New Alarm Notification Profile.

Twilio SMS Notification Profile Settings

The following table describes the settings on the Alarm Notification Profiles page for a Twilio SMS Notification profile.

SettingDescription
NameName for this alarm notification profile.
DescriptionDescription of the profile.
EnabledWhether the profile is enabled or disabled.
Twilio AccountSelect a Twilio account from the dropdown list.
Acknowledgement Allowed Enables users to respond to notifications directly from the SMS message; also known as Two-Way notification. If enabled, the Public Hostname property in the Twilio Account must be configured. 
Auditing ProfileSelect an audit profile from the dropdown list.

Note: Once your Notification profile is created, you can use it in an Alarm Pipeline.


Receiving Alarm Acknowledgement via Twilio

If you're using 2-way alarming, when a user acknowledges an alarm, Twilio's servers send the acknowledgement to your Ignition Gateway. This means your Ignition Gateway needs to be accessible from Twilio's servers. If you're running Ignition on the cloud, this is likely already the case. If Ignition is on-premise, you may need to explore one of the following options:

  1. Make use of port forwarding
  2. Put an Ignition alarming server in the cloud with a Gateway Network connection to your on-premise server.

Because there are often security implications of port forwarding, and a cost associated with adding an Ignition server in the cloud, often the SMS Notification module is chosen over the Twilio module for users running Ignition on-premise.




  • No labels