Skip to content

Commit bd38a88

Browse files
authored
Merge branch 'master' into develop
2 parents 6ad1a90 + 0a46081 commit bd38a88

File tree

2 files changed

+36
-46
lines changed

2 files changed

+36
-46
lines changed
52.4 KB
Loading

src/engage/onboarding.md

Lines changed: 36 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The following table shows a high-level checklist of tasks you’ll need to compl
3434
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3535
| Segment | 1. Verify Engage identifiers in your Segment workspace. <br> 2. Add any missing identifiers. |
3636
| 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 API credentials, then copy them into Engage settings. <br> 9. Warm up your IP. <br> 10. Contact SendGrid support. |
37-
| 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. Generate an API key, then copy it into the Engage settings. <br> 6. Configure an event webhook. |
37+
| 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. Generate an API key, then copy it into the Engage settings. |
3838
| WhatsApp | 1. Register a Twilio number with WhatsApp. <br> 2. Connect your Facebook account. <br> 2. Create the WhatsApp messaging service. |
3939

4040

@@ -197,69 +197,59 @@ Once you've completed IP warmup, your SendGrid account will be fully configured
197197

198198
## Stage 3: Create and configure Twilio SMS services
199199

200-
To add the ability to send SMS campaigns in Engage, you’ll now create a Twilio account, generate an API key, set up a phone number and messaging service, and configure event webhooks.
200+
To add the ability to send SMS campaigns in Engage, you’ll now create a Twilio account, set up a phone number and messaging service, and generate an API key.
201201

202-
### Create a Twilio account and generate an API key
202+
### Set up a Twilio Messaging Service
203203

204-
> info "Copying Twilio Credentials"
205-
> This step generates an Account SID, API key SID, and API key secret that you’ll later add to Segment. Make sure you’re ready to copy and save both before proceeding.
204+
> info "Phone Number Registration"
205+
> 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"}.
206206
207-
Start by creating your Twilio account and getting an API key for Engage:
207+
Once you've identified the type of phone number you'll use with Twilio Engage, follow these steps to create a Twilio Messaging Service:
208208

209209
1. Visit the [Twilio website](https://www.twilio.com/try-twilio){:target="_blank"} and sign up for a **paid account**. Trial accounts generate sending errors.
210-
2. In your Twilio console, select the **Account** dropdown menu, then **API keys & tokens**.
211-
3. On the Auth tokens & API keys page, click **Create API key**.
212-
4. Enter a name for the API key in the **Friendly name** field.
213-
5. Set the region to **United States (US1) - Default** and key type to **Main**.
214-
6. Click **Create API Key**.
215-
7. Copy and save both the **SID** and **Secret** field contents.
216-
217-
218-
![Copying the Twilio API key](images/apikeys.png "Copying the Twilio API key")
219-
220-
8. Return to the API keys & tokens page. In the **Live credentials** section, copy the Account SID credentials.
221-
222-
![Copying the Twilio Account SID key](images/twilioaccountsid.png "Copying the Twilio API key")
210+
2. [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"}.
211+
3. In the Twilio Console side menu, navigate to **Messaging > Services**.
212+
4. On the Messaging Services page, click **Create Messaging Service**.
213+
5. Enter a name for your Messaging Service.
214+
6. Under the Messaging use dropdown, select **Market my services**.
215+
7. From the **Sender Pool** tab, click **Add Senders**, then select the phone number you purchased in Step 1. Click **Step 3: Set up Integration**. Leave this tab open.
216+
8. Verify that the dropdown next to the **Request URL** field is set to **HTTP Post**.
217+
9. (If applicable:) Click **Step 4: Add compliance info**. Finish compliance setup, then click **Complete Messaging Service Setup**.
223218

224-
9. Switch to the browser tab with your Segment workspace.
225-
10. Navigate to **Engage > Engage settings > Channels**. Under **SMS Service with Twilio**, click the **Get Started** button. The **Set up and validate your Twilio account** page appears.
226-
11. Under **Enter your Twilio API Key information** (shown below), paste the Account SID, API Key SID, and API Key Secret you copied above into their corresponding fields.
227-
12. Click **Verify**, then click **Save Twilio Account.**
219+
### Generate an API key, and select your messaging service(s)
228220

229-
![Entering Twilio API key into Engage](images/engageapifields.png "Entering Twilio API key into Engage")
221+
> info "Copying Twilio Credentials"
222+
> This step generates an Account SID, API key SID, and API key secret that you’ll later add to Segment. Make sure you’re ready to copy and save both before proceeding.
230223
231-
> info ""
232-
> If you’re unable to verify your Account SID, 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.
224+
Start by creating your Twilio account and getting an API key for Engage:
233225

234-
### Set up a Twilio Messaging Service
226+
1. In your Twilio console, select the **Account** dropdown menu, then **API keys & tokens**.
227+
2. On the Auth tokens & API keys page, click **Create API key**.
228+
3. Enter a name for the API key in the **Friendly name** field.
229+
4. Set the region to **United States (US1) - Default** and key type to **Main**.
230+
5. Click **Create API Key**.
231+
6. Copy and save both the **SID** and **Secret** field contents.
235232

236-
> info "Phone Number Registration"
237-
> 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"}.
233+
![Copying the Twilio API key](images/apikeys.png "Copying the Twilio API key")
238234

239-
Once you've identified the type of phone number you'll use with Twilio Engage, follow these steps to create a Twilio Messaging Service:
235+
7. Return to the API keys & tokens page. In the **Live credentials** section, copy the Account SID credentials.
240236

241-
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"}.
242-
2. In the Twilio Console side menu, navigate to **Messaging > Services**.
243-
3. On the Messaging Services page, click **Create Messaging Service**.
244-
4. Enter a name for your Messaging Service.
245-
5. Under the Messaging use dropdown, select **Market my services**.
246-
6. From the **Sender Pool** tab, click **Add Senders**, then select the phone number you purchased in Step 1. Click **Step 3: Set up Integration**. Leave this tab open.
237+
![Copying the Twilio Account SID key](images/twilioaccountsid.png "Copying the Twilio API key")
247238

248-
To finish setting up your Messaging Service, you’ll now [configure an event webhook](https://www.twilio.com/docs/usage/webhooks/sms-webhooks){:target="_blank"}:
239+
8. Switch to the browser tab with your Segment workspace.
240+
9. Navigate to **Engage > Engage settings > Channels**. Under **SMS Service with Twilio**, click the **Get Started** button. The **Set up and validate your Twilio account** page appears.
241+
10. Under **Enter your Twilio API Key information** (shown below), paste the Account SID, API Key SID, and API Key Secret you copied above into their corresponding fields.
249242

250-
1. Switch to the browser tab or window with your Engage workspace.
251-
2. Navigate to **Engage > Engage settings > Channels**. Under **SMS Service with Twilio**, click the **Get Started** button.
252-
3. The **Set up and validate your Twilio account** overlay appears (pictured below). Click the **Copy webhook URL** button. Your computer copies the URL to your clipboard.
243+
![Entering Twilio API key into Engage](images/engageapifields.png "Entering Twilio API key into Engage")
253244

254-
![Engage webhook URL](images/engagewebhook.png "Engage webhook URL")
245+
11. Click **Verify**, then select the messaging services you want to use in your space.
255246

256-
4. Return to the Twilio Messaging Service setup tab. On the Integration page, select the **Send a webhook** radio button.
257-
5. Paste the URL you copied in Step 3 into the **Request URL** field (pictured below).
247+
![Selecting messaging services in Engage setup](images/messaging_service.png "Selecting messaging services in Engage setup")
258248

259-
![Twilio webhook field](images/requesturl.png "Twilio webhook field")
249+
12. Click **Save Twilio Account.**
260250

261-
6. Verify that the dropdown next to the **Request URL** field is set to **HTTP Post**.
262-
7. (If applicable:) Click **Step 4: Add compliance info**. Finish compliance setup, then click **Complete Messaging Service Setup**.
251+
> info ""
252+
> If you’re unable to verify your Account SID, 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.
263253
264254
## Stage 4: Create and configure Twilio WhatsApp services
265255

0 commit comments

Comments
 (0)