Skip to content

Commit e870f87

Browse files
authored
Merge pull request #339 from segmentio/repo-sync
repo sync
2 parents dd69f79 + 3947006 commit e870f87

File tree

3 files changed

+2
-99
lines changed

3 files changed

+2
-99
lines changed

.github/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Mixpanel
6060
namespace
6161
Okta
6262
Omnichannel
63+
onboarding
6364
Optimizely
6465
performant
6566
Preact

src/engage/overview/onboarding.md

Lines changed: 0 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,16 @@ This guide lists all required onboarding steps and walks you through Engage setu
1414

1515
You’ll set up Twilio Engage in three stages:
1616

17-
<<<<<<< HEAD
18-
1. Configure Personas Identifiers in your Segment workspace.
19-
2. Create and configure a SendGrid account.
20-
3. Create and configure Twilio SMS services.
21-
=======
2217
1. [Configure Personas Identifiers in your Segment workspace.](/docs/engage/overview/onboarding/#stage-1-configure-personas-identifiers-in-segment)
2318
2. [Create and configure a SendGrid account.](/docs/engage/overview/onboarding/#stage-2-create-and-configure-a-sendgrid-account)
2419
3. [Create and configure Twilio SMS services.](/docs/engage/overview/onboarding/#stage-3-create-and-configure-twilio-sms-services)
25-
>>>>>>> master
2620

2721
The following table shows a high-level checklist of tasks you’ll need to complete in each platform:
2822

2923
| Platform | Tasks |
3024
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3125
| Segment | 1. Check your Personas workspace for Engage identifiers. <br> 2. Add any missing identifiers. |
32-
<<<<<<< HEAD
33-
| SendGrid | 1. Create a SendGrid account. <br> 2. Upgrade your account to a Pro plan. <br> 3. Configure an IP. <br> 4. Create a SendGrid subuser. <br> 5. Authenticate your domain.* <br> 6. Enable subscription tracking. <br> 7. Enable an event webhook. <br> 8. Generate an API key, then copy it into the Engage settings. <br> 9. Enable automated IP warmup.* <br> 10. Contact the Twilio Engage team.* |
34-
=======
3526
| SendGrid | 1. Create a SendGrid account. <br> 2. Upgrade your account to a Pro plan. <br> 3. Configure an IP. <br> 4. Create a SendGrid subuser. <br> 5. Authenticate your domain. <br> 6. Enable subscription tracking. <br> 7. Enable an event webhook. <br> 8. Generate an API key, then copy it into the Engage settings. <br> 9. Enable automated IP warmup. <br> 10. Contact the Twilio Engage team. |
36-
>>>>>>> master
3727
| Twilio | 1. Create a Twilio account. <br> 2. Purchase phone number(s). <br> 3. If necessary, register phone number(s). <br> 4. Create a messaging service. <br> 5. Create a messaging service. <br> 6. Generate an API key, then copy it into the Engage settings. |
3828

3929

@@ -74,13 +64,6 @@ Start by creating a SendGrid account and then upgrading to the SendGrid Pro Plan
7464
7565
### Create a subuser and check the dedicated IP address
7666

77-
<<<<<<< HEAD
78-
Next, you’ll create a SendGrid subuser and ensure the dedicated IP has been assigned. Your SendGrid subuser username must begin with the prefix `twilio_engage_app_`. Add a unique identifier to the end of the prefix, for example, `twilio_engage_app_someusername`. Make a note of the combined username you’ve created; you’ll use it when you add your SendGrid information to Engage.
79-
80-
1. In your SendGrid space, navigate to **Settings > Subuser Management**, then click **Create New Subuser**.
81-
2. In the **Create New Subuser** window, enter the username you created above, then add an email address and password.
82-
3. In the same window, click the checkbox next to the IP address from Step 1.
83-
=======
8467
Next, you’ll create a SendGrid subuser and ensure that a dedicated IP has been assigned:
8568

8669
1. In your SendGrid space, navigate to **Settings > Subuser Management**, then click **Create New Subuser**.
@@ -89,18 +72,13 @@ Next, you’ll create a SendGrid subuser and ensure that a dedicated IP has been
8972
![Adding a SendGrid subuser](images/subuser.png "Adding a SendGrid subuser")
9073

9174
3. In the same window, click the checkbox next to the dedicated IP address for the subuser.
92-
>>>>>>> master
9375
4. Fill out the remaining fields in the window, then click **Create Subuser**.
9476
5. Using [SendGrid’s documentation](https://docs.sendgrid.com/ui/account-and-settings/dedicated-ip-addresses){:target="_blank"}, warm up the IP address.
9577

9678
### Authenticate your domain
9779

98-
<<<<<<< HEAD
99-
All further SendGrid onboarding steps require you to be signed in as the new subuser. If you're not logged in as the new subusers, log out of SendGrid, then log back in using the Engage credentials you created above.
100-
=======
10180
> info "Log in as the subuser"
10281
> All further SendGrid onboarding steps require you to be signed in as the new subuser you just created. If you're not logged in as the new subuser, log out of SendGrid, then log back in using the subuser credentials you created above.
103-
>>>>>>> master
10482
10583
Now, you’ll authenticate your domain with SendGrid and your DNS provider and [enable link branding](https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-link-branding){:target="_blank"}. Domain authentication protects your sending reputation by showing email providers that you’ve given SendGrid permission to send email campaigns for you.
10684

@@ -116,11 +94,7 @@ You’ll authenticate your domain using the SendGrid platform and your DNS provi
11694
Complete authentication by setting up reverse DNS:
11795

11896
1. Follow [SendGrid’s reverse DNS (rDNS) documentation](https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-reverse-dns){:target="_blank"}.
119-
<<<<<<< HEAD
120-
2. SendGrid provides you with five CNAME records and one A record. Add them to your DNS host.
121-
=======
12297
2. SendGrid provides you with one A record. Add it to your DNS host, along with the five CNAME records from the previous steps.
123-
>>>>>>> master
12498
3. Return to SendGrid and [verify your DNS](https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-reverse-dns#verifying){:target="_blank"}.
12599

126100
### Enable subscription tracking
@@ -132,21 +106,6 @@ You'll also need to enable [subscription tracking](https://docs.sendgrid.com/ui/
132106
3. At the end of the Subscription Tracking window, toggle **Setting State** to `enabled`.
133107
4. Click **Save**.
134108

135-
<<<<<<< HEAD
136-
### Enable event webhook and generate an API key
137-
138-
> info "Copying SendGrid Credentials"
139-
> This step creates an API key that you’ll later add to Segment. Make sure you’re ready to copy and save the key before proceeding.
140-
141-
You’ll now need to enable event webhooks, which trigger webhook notifications for campaign-related events like clicks and opens:
142-
143-
1. Within your SendGrid space, navigate to **Settings > Mail Settings**.
144-
2. Click the pencil edit icon next to **Event Webhook**.
145-
3. On the Event Webhook page, set authorization method to none.
146-
4. Copy and paste the following URL into the **HTTP Post URL** field (pictured below):
147-
148-
`https://engage-ma-webhook-api.engage.segment.com/sendgrid`
149-
=======
150109
### Enable event webhook
151110

152111
You’ll now need to enable event webhooks, which trigger webhook notifications for campaign-related events like clicks and opens:
@@ -159,16 +118,10 @@ You’ll now need to enable event webhooks, which trigger webhook notifications
159118
<br> `https://engage-ma-webhook-api.engage.segment.com/sendgrid`
160119

161120
![Adding the HTTP Post URL](images/webhook.png "Adding the HTTP Post URL")
162-
>>>>>>> master
163121

164122
5. Check all event types.
165123
6. Switch the Event Webhook Status toggle to `Enabled`. Click **Save**.
166124

167-
<<<<<<< HEAD
168-
Next, generate an API key within SendGrid. Have your Segment workspace open in another tab, as you’ll copy the API key and paste it into your Engage settings.
169-
170-
1. Within your SendGrid space, navigate to **Settings > API Keys**.
171-
=======
172125
### Generate an API key
173126

174127
> info "Copying SendGrid Credentials"
@@ -177,7 +130,6 @@ Next, generate an API key within SendGrid. Have your Segment workspace open in a
177130
Next, generate an API key within SendGrid. Have your Segment workspace open in another tab, as you’ll copy the API key and paste it into your Engage settings.
178131

179132
1. Within your SendGrid subuser space, navigate to **Settings > API Keys**.
180-
>>>>>>> master
181133
2. Click the **Create API Key** button.
182134
3. In the Create API Key window, name your API key using the prefix `twilio_engage_app_`, with a suffix of your choice added to the end, like `twilio_engage_app_example`.
183135
4. Select the **Full Access** radio button.
@@ -188,39 +140,24 @@ To finish linking the API key to your Segment account, follow these steps:
188140
1. Switch to the browser tab with your Personas workspace open.
189141
2. Navigate to **Personas > Campaigns**. Under **Send emails with SendGrid**, click the **Get Started** button.
190142
3. In the **Set up your email service** window (shown below), enter the subuser username [you previously created](#configure-a-sendgrid-ip-and-create-a-subuser) into the Subuser name field.
191-
<<<<<<< HEAD
192-
4. Paste the Subuser API Key ID and Subuser API Key you just copied from SendGrid into their respective fields.
193-
5. Click **Verify**.
194-
=======
195143
4. Paste the Subuser API Key ID and Subuser API Key you just copied from SendGrid into their respective fields, then click **Verify**.
196144

197145
![Adding the SendGrid API Key](images/apifields.png "Adding the SendGrid API Key")
198-
>>>>>>> master
199146

200147
### Enable Automated IP warmup
201148

202149
> info "Required Step"
203-
<<<<<<< HEAD
204-
> Reach out to the Engage team once you’ve enabled IP warmup in SendGrid.
205-
>
206-
To finish configuring your SendGrid account for usage with Twilio Engage, you’ll enable [automated IP warmup](https://docs.sendgrid.com/ui/sending-email/warming-up-an-ip-address){:target="_blank"}. As a best practice, wait to warm up your IP until you're ready to begin sending campaigns.
207-
=======
208150
> Notify the Engage team once you've completed IP warmup.
209151
210152
To finish configuring your SendGrid account for usage with Twilio Engage, you’ll enable [automated IP warmup](https://docs.sendgrid.com/ui/sending-email/warming-up-an-ip-address){:target="_blank"}. As a best practice, **only warm up your IP when you're ready to begin sending campaigns.**
211153

212-
>>>>>>> master
213154

214155
To enable IP warmup, follow these directions:
215156

216157
1. Within your SendGrid space, navigate to **Settings > IP Addresses**.
217158
2. On the **Dedicated IP Addresses** page, click the pencil edit button next to your Engage IP address.
218159
3. Under **Additional options** (pictured below), check **Use Automated IP warmup** and **Allow my subusers to send mail using this IP address**. Click **Save**.
219-
<<<<<<< HEAD
220-
4. **Required: [Reach out to the Engage team](https://segment.com/docs/engage/contact/). Let them know you’ve enabled IP warmup.**
221-
=======
222160
4. **Required: [Reach out to the Engage team](/docs/engage/contact/). Let them know you’ve enabled IP warmup.**
223-
>>>>>>> master
224161

225162
Your SendGrid account is now fully configured and ready to use with Engage. You’re ready to move to Stage 3 and configure Twilio SMS.
226163

@@ -235,53 +172,34 @@ To add the ability to send SMS campaigns in Engage, you’ll now create a Twilio
235172
236173
Start by creating your Twilio account and getting an API key for Engage:
237174

238-
<<<<<<< HEAD
239-
1. Visit the [Twilio website](https://www.twilio.com/try-twilio){:target="_blank"} and sign up for a paid account.
240-
=======
241175
1. Visit the [Twilio website](https://www.twilio.com/try-twilio){:target="_blank"} and sign up for a **paid account**. Trial accounts will generate sending errors.
242-
>>>>>>> master
243176
2. In your Twilio console, select the **Account** dropdown menu, then **API keys & tokens**.
244177
3. On the Auth Tokens & API Keys page, click **Create API key**.
245178
4. Enter a name for the API key in the **Friendly name** field.
246179
5. Set the region to **United States (US1) - Default** and key type to **Standard**.
247180
6. Click **Create API Key**.
248181
7. Copy the **SID** and **Secret** field contents.
249182

250-
<<<<<<< HEAD
251-
Finish linking your Twilio API key to Segment:
252-
=======
253183
![Copying the Twilio API key](images/apikeys.png "Copying the Twilio API key")
254-
>>>>>>> master
255184

256185
8. Switch to the browser tab or window with your Personas workspace.
257186
9. Navigate to **Personas > Campaigns**. Under **Send SMS messages with Twilio**, click the **Get Started** button. The **Set up your SMS service** page appears.
258187
10. Under **Enter your Twilio API Key information** (shown below), paste the SID and API Key Secret you copied above into their respective fields.
259188
11. Click **Verify**, then click **Save Twilio Account.**
260189

261-
<<<<<<< HEAD
262-
=======
263190
![Entering Twilio API key into Engage](images/engageapifields.png "Entering Twilio API key into Engage")
264191

265-
>>>>>>> master
266192
> info ""
267193
> If you’re unable to verify your SID or API Key secret, you may have copied an extra space at the end of one or the other. Verify that you’ve not added any extra characters or spaces, then try to verify again.
268194
269195
### Set up a Twilio Messaging Service
270196

271197
> info "Phone Number Registration"
272-
<<<<<<< HEAD
273-
> Depending on the phone number you purchase, you'll need to register the phone number for use. Read Twilio's documentation on registering [short code](https://www.twilio.com/docs/glossary/what-is-a-short-code){:target="_blank"}, [long code](https://support.twilio.com/hc/en-us/articles/1260800720410-What-is-A2P-10DLC-){:target="_blank"}, and [toll free numbers](https://support.twilio.com/hc/en-us/articles/360038172934-Information-and-best-practices-for-using-Toll-Free-SMS-and-MMS-in-the-US-and-Canada){:target="_blank"} to complete registration.
274-
275-
Follow these steps to create a Twilio Messaging Service:
276-
277-
1. Read [Twilio’s SMS messaging guide](https://support.twilio.com/hc/en-us/articles/360038173654-Comparison-of-SMS-messaging-in-the-US-and-Canada-for-long-codes-short-codes-and-toll-free-phone-numbers){:target="_blank"}. Choose the phone number type that best suits your use case*, then [purchase a number](https://support.twilio.com/hc/en-us/articles/223135247-How-to-Search-for-and-Buy-a-Twilio-Phone-Number-from-Console){:target="_blank"} within your Twilio Console.
278-
=======
279198
> You'll need to purchase a phone number to set up [Twilio Messaging](https://support.twilio.com/hc/en-us/articles/360038173654-Comparison-of-SMS-messaging-in-the-US-and-Canada-for-long-codes-short-codes-and-toll-free-phone-numbers){:target="_blank"}. Depending on the phone number type you purchase, you may have to register the number. Before completing this section, read Twilio's documentation on [short code](https://www.twilio.com/docs/glossary/what-is-a-short-code){:target="_blank"}, [long code](https://support.twilio.com/hc/en-us/articles/1260800720410-What-is-A2P-10DLC-){:target="_blank"}, and [toll free numbers](https://support.twilio.com/hc/en-us/articles/360038172934-Information-and-best-practices-for-using-Toll-Free-SMS-and-MMS-in-the-US-and-Canada){:target="_blank"}.
280199
281200
Once you've identified the type of phone number you'll use with Twilio Engage, follow these steps to create a Twilio Messaging Service:
282201

283202
1. [Purchase a phone number](https://support.twilio.com/hc/en-us/articles/223135247-How-to-Search-for-and-Buy-a-Twilio-Phone-Number-from-Console){:target="_blank"} within your Twilio Console. If necessary, [register the number](https://support.twilio.com/hc/en-us/articles/1260801864489-How-do-I-register-to-use-A2P-10DLC-messaging-){:target="_blank"}.
284-
>>>>>>> master
285203
2. In the Twilio Console side menu, navigate to **Messaging > Services**.
286204
3. On the Messaging Services page, click **Create Messaging Service**.
287205
4. Enter a name for your Messaging Service.
@@ -293,10 +211,6 @@ To finish setting up your Messaging Service, you’ll now [configure an event we
293211
1. Switch to the browser tab or window with your Personas workspace.
294212
2. Navigate to **Personas > Campaigns**. Under **Send SMS messages with Twilio**, click the **Get Started** button.
295213
3. A **Set up your SMS service** overlay appears (pictured below). Click the **Copy webhook URL** button. Your computer copies the URL to your clipboard.
296-
<<<<<<< HEAD
297-
4. Return to the Twilio Messaging Service setup tab. On the Integration page, select the **Send a webhook** radio button.
298-
5. Paste the URL you copied in Step 3 into the **Request URL** field (pictured below).
299-
=======
300214

301215
![Engage webhook URL](images/engagewebhook.png "Engage webhook URL")
302216

@@ -305,28 +219,15 @@ To finish setting up your Messaging Service, you’ll now [configure an event we
305219

306220
![Twilio webhook field](images/requesturl.png "Twilio webhook field")
307221

308-
>>>>>>> master
309222
6. Verify that the dropdown next to the **Request URL** field is set to **HTTP Post**.
310223
7. (If applicable:) Click **Step 4: Add compliance info**. Finish compliance setup, then click **Complete Messaging Service Setup**.
311224

312225
You’ve now configured both your SendGrid and Twilio accounts, and you’re ready to begin sending Engage campaigns.
313226

314227
## Next steps
315228

316-
<<<<<<< HEAD
317-
With accounts on all three platforms configured for Engage, you’ve completed Engage onboarding and are ready to create and send campaigns to your users.
318-
319-
Not sure where to start? Read the Engage documentation on [Sending an Email Campaign](#) and [Sending an SMS Campaign](#). To save time when creating Engage campaigns, view the SMS and [email templates guides](#).
320-
321-
If you’re planning to import contacts to your Engage audience(s), learn how to format your CSV file with the [Engage CSV Uploader instructions](#).
322-
323-
## Support
324-
325-
[Contact the Twilio Engage team](/docs/engage/contact) with any questions you may have about Engage onboarding and setup.
326-
=======
327229
With accounts on all three platforms configured, you’ve completed Engage onboarding and are ready to create and send campaigns to your users.
328230

329231
Not sure where to start? Read the Engage documentation on [sending email campaigns](/docs/engage/campaigns/email-campaigns/) and [sending SMS campaigns](docs/engage/campaigns/sms-campaigns/). To save time when generating Engage campaigns, check out the Engage guides on creating [SMS templates](/docs/engage/content/sms/template/) and [email templates](/docs/engage/content/email/template/).
330232

331233
If you’re planning to import contacts to Engage, learn how to [update your audiences with a CSV file](/docs/engage/profiles/csv-upload/).
332-
>>>>>>> master

vale-styles/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Mixpanel
6060
namespace
6161
Okta
6262
Omnichannel
63+
onboarding
6364
Optimizely
6465
performant
6566
Preact

0 commit comments

Comments
 (0)