Skip to main content
Version: 8.3

Configuration

Alarm Notification Profile

After installing the module, navigate to Services > Alarming > Notification and create an Alarm Notification Profile of type Twilio Notification.

Profile Settings

General

ParameterTypeRequiredDescription
NameTextYesName of the Alarm Notification Profile instance
DescriptionTextNoDescription of the Alarm Notification Profile instance
EnabledBooleanYesEnable/Disable the Alarm Notification Profile

Credentials

ParameterTypeRequiredDescription
Account SIDTextYesTwilio Account SID (accountSid), starting with AC, from the Console dashboard. Always used in the request URL path, whichever credential authenticates the call.
API Key SIDTextNoTwilio API Key SID (apiKeySid), starting with SK. Leave blank to authenticate with the Account SID and its Auth Token.
Auth Token / API Key SecretSecretYesThe secret paired with the credential above (authToken) — the account Auth Token when no API Key SID is set, or the API Key Secret when one is. Stored as an Ignition Secret.
RegionSelectYesTwilio region (region). US1 (default) or IE1. Selects the regional API host.
Which credential is used

The module builds HTTP Basic authentication from API Key SID + secret when an API Key SID is present, and falls back to Account SID + Auth Token when it is blank. The Account SID is always part of the request URL either way.

Region, Messaging Service and credentials must match

Twilio resources are region-scoped. The selected Region must be the one the Messaging Service and the credential were created in, or authentication fails. This applies whether you authenticate with an API Key or with the account Auth Token.

Messaging

ParameterTypeRequiredDescription
Messaging Service SIDTextYesSID of the Twilio Messaging Service (messagingServiceSid), starting with MG, used to send outgoing messages. Its sender pool determines what recipients see as the sender.

Auditing

ParameterTypeRequiredDescription
Audit ProfileReference (ignition/audit-profile)NoOptional audit profile for logging notification activity. Delete-protected and rename-tracked.

See Usage → Audit Logging for the fields each record stores.


Regions

RegionLocationAPI hostNotes
US1United States (Virginia)api.twilio.comDefault and global region
IE1Ireland (Dublin)api.dublin.ie1.twilio.comEU data residency — message data is processed and stored in the EU

User Contact Configuration

For a user to receive Twilio notifications, they must have a contact of the standard Ignition SMS contact type. Only SMS contacts are used by this module, and every SMS contact on the user is messaged.

  1. Navigate to Platform > Security > User Sources
  2. Open the user source's menu, choose Manage Users, and edit the user
  3. In the Contact Info section, add a contact of type SMS
  4. Enter the phone number in E.164 format (e.g., +33612345678)
Phone Number Format

Numbers are passed to Twilio exactly as stored — the module does not normalise them. Twilio requires E.164: a +, the country code, then the subscriber number, with no spaces or separators (e.g. +33612345678, +15551234567). A number stored in any other form is rejected by Twilio.


Per-Alarm Custom Message

The module supports a per-alarm custom message via an extended alarm property (CustomTwilioMessage).

  1. Open the tag/alarm configuration in the Designer
  2. In the Alarming section, find the Twilio Notification Properties category
  3. Set the Custom Message property

When the custom message is non-blank, it overrides the notification block's Message template for that alarm. It does not apply to throttled notifications — when several alarm events are batched, the Throttled Message template is always used.