18
User Guide Integrating Informatica’s SMS Text Messaging API Into Marketo Step by Step Using “Webhooks”

Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

  • Upload
    others

  • View
    8

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

User Guide

Integrating Informatica’s SMS Text Messaging API

Into MarketoStep by Step Using “Webhooks”

Page 2: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

This document contains Confidential, Proprietary and Trade Secret Information (“Confidential Information”) of Informatica Corporation and may not be copied, distributed, duplicated, or otherwise reproduced in any manner without the prior written consent of Informatica.

While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Informatica does not accept responsibility for any kind of loss resulting from the use of information contained in this document. The information contained in this document is subject to change without notice.

The incorporation of the product attributes discussed in these materials into any release or upgrade of any Informatica software product—as well as the timing of any such release or upgrade—is at the sole discretion of Informatica.

Protected by one or more of the following U.S. Patents: 6,032,158; 5,794,246; 6,014,670; 6,339,775; 6,044,374; 6,208,990; 6,208,990; 6,850,947; 6,895,471; or by the following pending U.S. Patents: 09/644,280; 10/966,046; 10/727,700.

This edition published October 2014

Page 3: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

1Integrating Informatica’s SMS Text Messaging API Into Marketo

User Guide

Table of Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Step 1: Configure the Webhook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Step 2: Create the Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Step 3: Create the Smart Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Step 4: Create a Landing Page to Test Webhook . . . . . . . . . . . . . . . . . 11

Page 4: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

2

IntroductionSmartphones and other mobile devices are nearly ubiquitous, making SMS a powerful and easy way to communicate with your employees, partners, customers, and prospects. Using Marketo’s “Webhook” capabilities, Informatica’s SMS Mobile Messaging API enables immediate, tangible results for your mobile campaigns. The integrated solution supports carriers throughout the world, making text messaging an easy-to-use addition to any Marketo solution.

By using Marketo’s triggered campaigns and workflow capabilities alongside Informatica’s real-time, powerful SMS delivery capabilities, the possibilities are endless.

This document explains the Informatica SMS integration using the example of a text message notifying a salesperson’s mobile device of a new lead filling out a web form. You can use the SMS Webhook demonstrated within this example to create other use cases that make sense within your organization - you are certainly not limited to this one. There are four steps to setting up this example:

1. The Webhook must be configured to communicate with Informatica’s SMS API.

2. A form must be created. At this point, as the prospect data is collected, this form will trigger a “Smart Campaign” that will send the SMS message.

3. The Smart Campaign must be created and attached to the triggering business process, such as clicking on the Submit button of a created Web-to-lead form.

4. A test landing page needs to be created to check the new functionality. You can later insert your form into a real landing page.

In addition, you must have credentials from Informatica (a license key) to get the SMS message successfully delivered to the target mobile device. These can be obtained via subscription from Informatica at [email protected]. Free trials are available.

Step 1: Configure the WebhookThe Marketo Web application communicates with Informatica using a “Webhook,” which uses the REST protocol to communicate with Informatica’s SMS API. REST, or Representational State Transfer, is a Web-based architecture for enabling different hardware and software platforms to communicate via a common text-based XML format.

Here is an example of a REST call that sends an SMS message using Informatica’s API:

http://ws.strikeiron.com/StrikeIron/SMSAlerts4/GlobalSMSPro/SendMessage?LicenseInfo.RegisteredUser.UserID=<Strikeiron_License_Key>&SendMessage.ToNumber=9191234567&SendMessage.MessageText=This is a test SMS message.

You can test the above REST call by copying and pasting the information above into the address URL of any web browser such as Firefox, Google Chrome, or Internet Explorer. Be sure to edit the REST call information by supplying your Informatica license key obtained from Informatica and a working mobile number to get an actual message delivered. Do this by replacing the StrikeIron_License_Key field with your 18-22 digit license key, and replace the phone number listed after

Page 5: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

3Integrating Informatica’s SMS Text Messaging API Into Marketo

“ToNumber=” with the mobile number you will be texting. Note that you need to only provide the recipient’s mobile number as well as the message text. There is no need to provide mobile carrier information since the service handles all of that in real-time when the service is invoked.

It is the various components of the above REST call that we will insert into the Marketo Webhook.

Note the question mark (?) in the middle of the actual REST call. This question mark separates the endpoint of the API (the URL where the API lives on the Internet, i.e. Informatica servers) from the parameters that are supplied along with the REST call.

Once logged into your Marketo account, go to “Admin.”

Within Admin, you will see the ability to “Manage Webhooks.” Click on “New Webhook.”

Page 6: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

4

The following form will appear and allow you to create your SMS Webhook:

Use the following configuration for the SMS Webhook:

• Webhook Name: Use a name that will make sense in your campaigns. Here we’ve used a generic label, “SMS Notification,” but if you will have more than one SMS notification, you should be more specific.

• Description: Enter a description for your Webhook. This will help others who come in later to view your Webhook to know exactly its purpose.

• URL: This is the base URL for the Informatica REST call. Copy the following URL: http://ws.strikeiron.com/StrikeIron/SMSAlerts4/GlobalSMSPro/SendMessage

• Request Type: POST

• Template: Three parameters must be included here – License Key, To Number and Message Text.

Page 7: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

5Integrating Informatica’s SMS Text Messaging API Into Marketo

Here is a sample of the template text:

LicenseInfo.RegisteredUser.UserID=XXXXXXXXXXXXXXXXXXXX&SendMessage.ToNumber=9191234567&SendMessage.MessageText=New Lead Notification --> {{lead.Full Name}} email: {{lead.Email Address}}

- LicenseInfo .RegisteredUser .UserID – Informatica License Key. Replace the XXXXXXXXXXXXXXXXXXXX in this example with your Informatica license key.

- SendMessage .ToNumber – The phone number to which you want to send the SMS message. In this example, we have entered our sales representative’s mobile number directly. If you want to change this campaign to send an outgoing message to a lead, you could enter the token {{lead.Mobile Phone Number}} for the “To Number.” To include tokens in any part of the template section, move your cursor to the correct insertion place and click on “Insert Token” button. Choose the field that you wish to insert. Tokens indicate to Marketo to integrate actual lead data into the Webhook, as the field will be populated by the lead data for the record that triggers the invocation of the Webhook.

- SendMessage .MessageText – This is the content to be sent out via SMS. You can insert tokens within the message text to customize it per lead, as {{lead.Full Name}} and {{lead.Email Address}} were entered above.

• Request Token Encoding: None

• Response Type: XML

The Webhook is now ready to be used by the Marketo system.

Page 8: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

6

Step 2: Create the Form

Creating a form is a standard activity within Marketo. More information can be found within the Marketo help documentation. In “Design Studio,” click on “New” and create a “New Form”:

When the form is created, click on “Edit Form.” (You may be automatically taken to this screen upon creation, if you chose the “Open in Editor” option.)

Page 9: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

7Integrating Informatica’s SMS Text Messaging API Into Marketo

Walk through steps 1-3 to create your form. Step 1 is to add field details to your form. Step 2 allows you to pick the theme and settings for your form. Finish and approve your form in Step 3.

Page 10: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

8

Step 3: Create the Smart CampaignThis also is a standard activity within Marketo. More information can be found within the Marketo help documentation if necessary about creating Smart Campaigns.

Click on “Marketing Activities” and then “New” and “New Smart Campaign.” Give the campaign a name and decide which folder to store it in.

Page 11: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

9Integrating Informatica’s SMS Text Messaging API Into Marketo

Next, click the “Smart List” tab. Drag the “Fills out Form” Trigger from the right to the white canvas, and then choose the form name that you created in step 2 (ours was Email Capture Form).

Page 12: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

10

Move on to the next tab, “Flow.” Drag “Call Webhook” onto the white canvas and choose the “SMS Notification” Webhook created in Step 1.

Page 13: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

11Integrating Informatica’s SMS Text Messaging API Into Marketo

Lastly, click on “Schedule” and “Activate” the Campaign. The campaign is now ready.

Step 4: Create a Landing Page to Test Webhook

This also is a standard activity within Marketo. More information can be found within the Marketo help documentation. Click on “New” and then “New Landing Page.”

Page 14: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

12

Page 15: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

13Integrating Informatica’s SMS Text Messaging API Into Marketo

When the landing page is created, click on “Edit Landing Page.” (You may be automatically taken to this screen upon creation, if you chose the “Open in Editor” option.)

On the Landing Page Designer, under “Insert Elements,” drag the “Form” object onto the white canvas. Choose the “Email Capture” Form created in step 2. For the purposes of this test, go ahead and select “Stay on this Page” for the Follow-up Page option. Then click the “Insert” Button.

Page 16: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

14

Close out of the Landing Page Designer when you are satisfied with your Landing Page. Go to “Landing Page Actions” and click to “Approve” your page.

The notification will appear on the mobile device, having been delivered to the number configured in the Webhook in step 1.

Page 17: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

User Guide

Congratulations! You have successfully integrated Informatica’s SMS API into Marketo. You now have the ability to create SMS-enabled processes within the Marketo platform!

You can also customize this Webhook and create other new, more sophisticated Webhooks that use the Informatica SMS API. Mobile-enabling your sales and marketing teams, as well as creating innovative mobile campaigns, can pay tremendous dividends and substantially increase the ROI on your Marketo system.

Page 18: Integrating Informatica’s SMS Text Messaging API … Documentation...Integrating Informatica’s SMS Text Messaging API Into Marketo 3 “ToNumber=” with the mobile number you

Worldwide Headquarters, 100 Cardinal Way, Redwood City, CA 94063, USA Phone: 650.385.5000 Fax: 650.385.5500 Toll-free in the US: 1.800.653.3871 informatica.com linkedin.com/company/informatica twitter.com/InformaticaCorp

© 2013 Informatica Corporation. All rights reserved. Informatica® and Put potential to work™ are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks.

IN00_0000_00000

About InformaticaInformatica Corporation (Nasdaq:INFA) is the world’s number one independent provider of data integration software. Organizations around the world rely on Informatica to realize their information potential and drive top business imperatives. Informatica Vibe, the industry’s first and only embeddable virtual data machine (VDM), powers the unique “Map Once. Deploy Anywhere.” capabilities of the Informatica Platform. Worldwide, over 5,000 enterprises depend on Informatica to fully leverage their information assets from devices to mobile to social to big data residing on-premise, in the Cloud and across social networks. For more information, call +1 650-385-5000 (1-800-653-3871 in the U.S.), or visit www.informatica.com.