Articles - Personnel

Set up Twilio for crew change notifications

To send crew change notifications by text message, we use a webhook in Helm CONNECT. This webhook sends data to a communication provider so you can send text messages in real time. Our webhook is designed to work with Twilio, a leading SMS provider. To use the text message functionality, you'll need to do the following: 

  • Sign up for a Twilio account
  • Re-order the URL provided by Twilio
  • Configure a webhook in Helm CONNECT
  • Set the crew change notification preference in Helm CONNECT

Set up a Twilio account

Sign up for a Twilio account to get two things: 

  • An SMS-enabled phone number that will send the text messages
  • A URL with the authentication token that Helm CONNECT will use to integrate with Twilio

Contact Twilio at www.twilio.com or (855) 910-8712 to set up your account. 

Re-order the Twilio URL

Before you set up the webhook in Helm CONNECT, you'll need to re-order the URL that Twilio provides. To do this: 

  1. Copy the URL from Twilio into a text editor, such as MS Word or Notepad.

    NoteBefore copying the URL from Twilio, make sure you select the Auth Token check box so Twilio includes the authentication token in the URL. This authentication token must be included for the callback URL to work properly in Helm CONNECT.

  2. Review the example below to understand the parts of the Twilio URL. You will keep and re-order the highlighted text and discard the rest of the text.
  3. Re-order the URL and prepare to paste it into the Helm CONNECT webhook, which you will create in the next step. 

PersConfirmSched_RemapURLWebhook_1.13.png

Set up a webhook in Helm CONNECT

Once you have the Twilio phone number and the callback URL, you'll configure a webhook in Helm CONNECT. The webhook has three parts (also known and 'JSON payloads') called From, To and Body. 

  1. Under the Setup menu, click Webhooks.
  2. Click Add Webhook.
  3. From the Entity list, choose Crew Changes.
  4. Paste the re-ordered URL from Twilio into the Callback URL field.
  5. Add your first key.
    • Click Add JSON Payload.
    • In the Key field, name it From.
    • In the Value box, type in the phone number provided by Twilio.
    • Click Save.
  6. Add your second key.
    • Click Add JSON Payload.
    • In the Key field, name it To.
    • Click the plus sign + on the Crew Cell Phone option to add it to the Value box.
    • Click Save.
  7. Add your third key.
    • Click Add JSON Payload.
    • In the Key field, name it Body.
    • Click the plus sign + on the Message Body to add it to the Value box.
      • This Message Body item will load the default text and acknowledge/decline links.  
      • (Optional) You can add your own introduction or end text above and/or below the Message Body. 
    • Click Save.

SetupWebhook_TextMsgBody_1.13.png

Set the crew change notification preference in Helm CONNECT

For each person who wants to receive the crew change notification by text message, you'll need to enter a valid cell phone number in the Cell Phone field in Management > People > Details. This number must contain the country code and area code.

NoteIn Helm CONNECT Version 1.13, the Crew Change Notification field is set to 'Email' by default. You will need to set this field to 'Text' or 'Email and Text' to send text messages.