10.0: Send SMS notifications using Twilio and automations

[jstanden]

Introduction

Cerb can use services like Twilio to deliver SMS messages to workers and customers.

In this example we'll create a reusable automation function that allows us to send an SMS message from any event or interaction.

Create a connected account for Twilio

First, if you don't already have a Twilio-based connected account in Cerb, follow these instructions to create one:
https://cerb.ai/guides/integrations/twilio/

Make a note of your Twilio Account SID since you'll need it in the next step.

As well, you'll need to choose one of your verified caller ID numbers as the sender.

Import the package in Cerb

Navigate to Setup -> Packages -> Import:

{
  "package": {
    "name": "Send SMS messages using Twilio",
    "requires": {
      "cerb_version": "10.0.0"
    },
    "configure": {
      "prompts": [
        {
          "type": "chooser",
          "label": "Twilio Account:",
          "key": "prompt_twilio_account_id",
          "params": {
            "context": "cerberusweb.contexts.connected_account",
            "single": true,
            "query": "service:(name:twilio)"
          }
        },
        {
          "type": "text",
          "label": "Twilio SID:",
          "key": "prompt_twilio_sid",
          "params": {
            "placeholder": "ACa1b2c3d4..."
          }
        },
        {
          "type": "text",
          "label": "From Number:",
          "key": "prompt_twilio_from",
          "params": {
            "placeholder": "15551234567"
          }
        }
      ]
    }
  },
  "records": [
    {
      "uid": "automation_twilio",
      "_context": "automation",
      "name": "wgm.service.twilio.sms",
      "description": "Send SMS messages through Twilio",
      "extension_id": "cerb.trigger.automation.function",
      "script": "inputs:\n  text/to:\n    type: freeform\n    required@bool: yes\n  text/message:\n    type: freeform\n    required@bool: yes\n\nstart:\n  set:\n    twilio_sid: {{{prompt_twilio_sid}}}\n    params:\n      From: {{{prompt_twilio_from}}}\n      To: {{inputs.to}}\n      Body: {{inputs.message}}\n\n  http.request:\n    output: response\n    inputs:\n      url: https://api.twilio.com/2010-04-01/Accounts/{{twilio_sid}}/SMS/Messages.json\n      method: POST\n      authentication: cerb:connected_account:{{{prompt_twilio_account_uri ?: prompt_twilio_account_id}}}\n      headers@text:\n        Content-Type: application/x-www-form-urlencoded\n      body: {{params|url_encode}}",
      "policy_kata": "commands:\n  http.request:\n    deny/method@bool: {{inputs.method != 'POST'}}\n    deny/url@bool: {{inputs.url is not prefixed ('https://api.twilio.com/')}}\n    deny/auth@bool: {{inputs.authentication != 'cerb:connected_account:{{{prompt_twilio_account_uri ?: prompt_twilio_account_id}}}'}}\n    allow@bool: yes"
    }
  ]
}

Click the Import button.

Select your Twilio account and paste your Account SID and verified caller ID number:

Click the Import button again.

Testing the automation

Hold SHIFT and click on the bubble for wgm.example.twilio.sms to edit the automation.

Enter an input in the lower left, like:

inputs:
  to: "15551234567"
  message: Hello from Cerb!

Change 15551234567 to your mobile number.

Click the run button:

You should receive an SMS message to your mobile device.

Next steps

You can call this function from any automation to send an SMS message.

start:
  function/twilio:
    uri: cerb:automation:wgm.service.twilio.sms
    inputs:
      to: 15551234567
      message: Hello from Cerb!

Make sure to add access to the function in your automation policy:

commands:
  function:
    deny/uri@bool: {{uri != 'cerb:automation:wgm.service.twilio.sms'}}
    allow@bool: yes

In automations with a worker dictionary, like interactions, you can use the placeholder {{worker_mobile}} to reference a worker's mobile number (if configured).