Trigger SMS based on Segment Events

Created by: Twilio

SMS
JavaScript
Quick Deploy

(information)

Info

Regulations require that you first register your number to use these resources to send SMS traffic to US and Canadian mobile destinations. If you are sending to Canada or the US and have not already done so, please see our documentation to register your Twilio phone number or Toll-Free number before you use this template.

How it works:

Uses Twilio Functions to host the webhook for Segment
Uses Segment's Webhooks destination to receive event notifications to the app
Sends out an SMS to a number when a Segment event occurs

Notes:

If you're new to Segment, you can visit this link to create a free developer account.
If you are not familiar with the concept of events, check out these docs to learn more about Segment's API.

Report this template

Quick Deploy to TwilioGet CodeUse Twilio CLI

Launch and test this app in a few minutes with Quick Deploy. No server needed. Quick Deploy will automatically configure and deploy this app using Twilio Functions. Learn more about Twilio Functions

Get a Twilio phone number
Your app requires a Twilio phone number to operate, this is your application's source number to receive messages or calls.
You will get a US number that is configured for this application. You can change this or port over an existing number later. International number regulations
Segment Event
The name of the Segment event you want to be notified about
Segment Event
How do I get this?
My Phone Number
Segment event notifications will be sent to this E.164-formatted phone number
My Phone Number
How do I get this?
Click the button below to deploy your app
This will use the details entered above to deploy your application to Twilio Functions.
You will be able to view the application in the browser and edit it using the Functions UI.

Currently only available in JavaScript. Request hosting support for other languages

Install Node.js
The Node.js runtime is required to run the Twilio CLI and the sample code.
Download and install Node.js
Install Twilio CLI
The Twilio CLI is a command line tool that allows you to interact with Twilio APIs and services, and is necessary to deploy this template.
The suggested way to install the Twilio CLI on macOS is to use Homebrew. If you don't already have it installed, visit the Homebrew site for installation instructions and then return here.
Once you have installed Homebrew, run the following command to install the Twilio CLI:
brew tap twilio/brew && brew install twilio
Not using macOS? View the docs on all other installation methods.
Install the Serverless Toolkit
Beyond the base commands, Twilio CLI's functionality can be extended through plugins. In this case, the Serverless Toolkit plugin is needed to deploy the serverless functions that will power this template.
twilio plugins:install @twilio-labs/plugin-serverless
Learn more about Twilio CLI plugins
Login to the Twilio CLI
In order for the CLI to access your Twilio account and execute commands on your behalf, you need to log in and provide your Twilio credentials. This can be done by running:
twilio login
You will be prompted for your Account SID and Auth Token, both of which you can find on the dashboard of your Twilio console.
Create and configure a project with this template
To create a new project with the name example and the current template, run the following command:
twilio serverless:init example --template=segment-event-notification
This will create a new directory called example (or whatever name you picked) and will download all necessary files and dependencies for you.
(information)
Check your template's README
Depending on the template, there might be additional setup instructions necessary to make the project work.
Check the instructions for this template to see if there are any additional steps to complete.
Host on Twilio
You can now deploy your code by running the following command:
cd example twilio serverless:deploy

Trigger SMS based on Segment Events

Info

Check your template's README