Creating an SMS Notification

This guide will help you create an SMS Notification to send a text message to a newly signed up user using our Twilio integration.

Requirements

To follow the steps in this tutorial, you should understand the concept of notifications. You'll also use the sign-up form you created in a previous tutorial and a user property phone_number. As you'll use our Twilio integration, you need to ensure that the to number is formatted according to Twilio's phone number format guideline.

• Form Configuration
• Notifications
• Creating a Property for All Users
• Creating a Sign-Up Form
• Twilio's phone number format guideline

Steps

Creating an SMS Notification is a two-step process:

Step 1: Create SMS Notification

app/smses/welcome_user.liquid

---
to: '{{ form.properties.phone_number }}'
---
Hello {{ form.first_name }} via sms.

This assumes that you have already created a Sign-Up Form and configured the phone_number property.

Please note, that the phone number should include a country code. On the production site, you have to take into consideration that users might not know their country code, or what a country code is. For simplicity in this example though, assume that the user provides the correct input. For production, you might find [to_mobile_number][/api-reference/liquid/platformos-filters#to_mobile_number] useful.

Step 2: Add SMS Notification to the Sign-Up Form

Add the SMS Notification you created to the Sign-Up Form configuration.

The SMS notification name is a path of the file relative to the smses directory, without extension.

In our example the path to the file is app/smses/welcome_user.liquid and the bolded part is the name - welcome_user. As the result of adding:

sms_notifications:
  - welcome_user

to the Sign-Up Form, the content of forms/developer_sign_up.liquid in the configuration section should look as follows:

---
name: developer_sign_up
resource: User
resource_owner: anyone
fields:
  email:
  password:
  first_name:
    validation: { presence: true }
  properties:
    phone_number:
      validation:
        phone_number: true
  ...
sms_notifications:
  - welcome_user
---

Next steps

Congratulations! You have created an SMS Notification. Now you can learn about creating an API Call Notification.

• Creating an API Call Notification