Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Twilio Messaging] - adding docs for new Twilio Messaging Destination #7306

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9044e32
adding docs for twilio messaging
joe-ayoub-segment Dec 9, 2024
d62b18f
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
9538fe7
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
d91990e
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
af135b3
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
b3cb79c
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
9fe9391
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
1ef63e4
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
0d1aa85
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
90ba5f2
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
5fb3798
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
f7af2a6
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
6ae57c6
Update src/connections/destinations/catalog/actions-twilio-messaging/…
joe-ayoub-segment Dec 12, 2024
c506ba1
add destination id and correct name
tcgilbert Dec 13, 2024
59b1d5f
setting hidden true
joe-ayoub-segment Dec 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: [Twilio Messaging] Destination
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we just need to add the destination ID

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @stayseesong here is the destination ID
674f23ece330374dc1ecc874

---

{% include content/plan-grid.md name="actions" %}

[Twilio Messaging](https://www.twilio.com/en-us/messaging/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} allows businesses to send and receive SMS, MMS, WhatsApp and other messaging platform messages, enabling direct communication with customers. Use this Destination to send SMS, MMS, WhatsApp or Messenger messages via Twilio Messaging.

This destination is maintained by Segment. For any issues with the destination [contact the Segment Support team](mailto:[email protected]).

## Getting started

### Create Twilio API Key and Secret

1. Sign in to your [Twilio Console](https://console.twilio.com/). On the "Twilio Home" page save the **Account SID** value securely. You will need it in a later step.
2. While still on the "Twilio Home" page, click on **Go to API Keys**.
3. On the "API keys & tokens" page, click **Create API key** then follow the instructions to create the key. **Key Type** should be set to Standard.
4. On the "Copy secret key" page, save the **SID** and **Secret** values securely. You will need these in a later step.
5. Click the **Done** button to create the API Key.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

### Create the Twilio Messaging Destination
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

1. From your Segment workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Twilio Messaging".
2. Select the Twilio Messaging tile and click **Add Destination**.
3. Select an existing Source to connect to Twilio Messaging.
4. On the Settings page, provide the **Twilio Account SID**, **Twilio API Key SID** and **Twilio API Key Secret** values.
5. Enable the Destination then click the **Save Changes** button.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

### Configure the Send message Mapping
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

1. From the Twilio Messaging Destination's **Settings** page, click **Mapping** > **New Mapping**.
2. Select the **Send message** Action.
3. Provide Mapping Trigger and Field values to configure the Mapping. Then Save and Enable the Mapping.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

{% include components/actions-fields.html %}

## Additional information

### Supported messaging channels
Messages can be sent via SMS, MMS, WhatsApp and Facebook Messenger channels.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

### Supported Content Template types
The following Twilio Content Template types are supported: **Text**, **Media**, **Quick reply**, **Call to action**, **List picker**, **Card**, **WhatsApp card**, **WhatsApp Authentication** and **Catalog**.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

### Inline messages
Messages can also be sent without referencing a Twilio Content Template. In this case the message body, Media URLs, and variables can be defined directly in Mapping fields. Segment then constructs the final message body by combining the provided body and variables before sending it through Twilio.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

1. Select **Inline** from the 'Content Template Type' mapping field.
2. Provide the message body in the **Inline Template** field. Variables can be included using Handlebars notation. e.g. {{first_name}}
3. Provide Media URLs in the **Inline Media URLs** field.
4. Define variables using the **Inline Variables** field. Make sure to define variables for every variable included in the message body.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

### Can templates be defined or edited in Segment?
Segment does not have a Content Template Builder capability. Content Templates must be built in Twilio first, then referenced in Segment. Alternatively, the 'Inline message' option can be used (see above).

### Sender details
Three types of Sender types are supported:
1. Phone Number - An E.164 formatted phone number. Check in the Twilio Console to ensure that the selected number supports the selected Channel type.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved
2. Messenger Sender ID - Supported only when the **Facebook Messenger** channel type is selected.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved
3. Twilio Messaging Service - Supported for all channels.
joe-ayoub-segment marked this conversation as resolved.
Show resolved Hide resolved

### Variables
Variables can be used in both Content Templates and for inline messages and can be included in the message body as well as Media URLs. Variables referenced when using Content Templates must be pre-defined in Twilio.