Skip to main content
Version: 8.3

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 Twilio module faults and its profile type is unavailable. It ships with any Ignition install that includes the Alarming feature.
  • A Twilio account with a Messaging Service (MG…) created in the region you intend to use
  • Twilio credentials: an API Key SID and its secret (recommended), or the Account SID and its Auth Token
  • Outbound HTTPS access from the gateway to the Twilio API (port 443). No inbound connectivity is required.

Twilio Preparation

Before configuring the module, collect three values from the Twilio Console:

  1. Account SID — starts with AC, shown on the Console dashboard. Always used in the request URL, whichever credential you authenticate with.
  2. Messaging Service SID — starts with MG. Create a Messaging Service and add a sender (a phone number, short code or alphanumeric sender id) to its sender pool.
  3. A credential — either an API Key SID (starts with SK) and its secret, or the Account Auth Token.
Prefer an API Key

Twilio recommends API keys over the account Auth Token: a key can be revoked on its own without rotating the account credential. Either type works with either region.

Everything must be in the same region

Messaging Services and API credentials are region-scoped. A Messaging Service created in US1 cannot be driven by IE1 credentials, and vice versa — the request fails authentication. Pick the region first, then create the Messaging Service and key inside it.

Download

Download Twilio 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 Twilio-Alarm-Notification.modl file
  5. Review and accept the license agreement
  6. The module installs and registers the Twilio 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 Twilio Notification appears as an available profile type

Network Requirements

Outbound (Ignition to Twilio)

The gateway must be able to reach the regional Twilio API host:

RegionDestinationProtocolPort
US1 (default)api.twilio.comHTTPS443
IE1api.dublin.ie1.twilio.comHTTPS443

Inbound

None. The module sends only; it registers no servlet and opens no callback path, so no inbound firewall rule or public address is needed.

Troubleshooting

IssueSolution
Module faults / not runningConfirm the Alarm Notification module is installed and running; check the gateway logs
"Twilio Notification" not in profile typesVerify the Alarm Notification module is running
Cannot reach TwilioCheck firewall rules for outbound HTTPS to the region's API host
Authentication failures after switching regionThe credential must belong to the selected region — re-check that the API Key or Auth Token was created in the same region as the Messaging Service
Notifications not sentTrial expired — activate a license, see Licensing