Integrating StrikeIron's Mobile ID API Into Marketo
Step by Step Instructions .
This document explains one use case of the StrikeIron Mobile ID integration. There are four steps to setting up this example:
In addition, you must have credentials from StrikeIron (a license key) to get the Mobile ID output. These can be obtained via subscription from StrikeIron at sales@strikeiron.com. Free trials are available.
Step 1: Configure the Webhook
The Marketo Web application communicates with StrikeIron using a “Webhook,” which uses the REST protocol to communicate with StrikeIron’s SMS API. REST, or Representational State Trans- fer, is a Web-based architecture for enabling different hardware and software platforms to commu- nicate via a common text-based XML format.
Here is an example of a REST call of StrikeIron’s Mobile ID API:
http://ws.strikeiron.com/StrikeIron/MobileID2/CellPhoneVerification/CheckForCellPhone?Lice nseInfo.RegisteredUser.UserID=<StrikeIron_License_Key>&CheckForCellPhone.phoneNumber= <9196787658>
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 StrikeIron license key obtained from StrikeIron and a working number. Do this by replacing the StrikeIron_License_Key field with your 18-22 digit license key, and replace the phone number listed one you would like to test. (When setting up a webhook you would probably want to use a Marketo token as opposed to a single address.
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. StrikeIron 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.”
The following form will appear and allow you to create your SMS Webhook:
Use the following configuration for the Mobile ID Webhook:
• Webhook Name: Use a name that will make sense in your campaigns. Here we’ve used a generic label, “MobileID”.
• 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 StrikeIron REST call. Copy the following URL:
http://ws.strikeiron.com/StrikeIron/MobileID2/CellPhoneVerification
• Request Type: POST • Template: Two parameters must be included here – License Key and Phone Number
Here is a sample of the template text:
- LicenseInfo.RegisteredUser.UserID – StrikeIron License Key. Replace the XXXXXXXXXXXXXXXXXXXX in this example with your StrikeIron license key.
- CheckForCellPhone.phoneNumber– The phone number that you want to check. You could also change this to a token to run against a list of numbers at once. You could enter the token {{lead.Phone Number}} for the “Phone 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.
• Request Token Encoding: None • Response Type: XML
Once you save these options, it is time to add Response Mappings to your Webhook. This maps the return values that the StrikeIron Email Verification and Hygiene service returns to Marketo lead fields. Before you map the Response Mappings, it is recommended that you create 5 new fields (you can actually name them whatever you would like):
• StrikeIron_MobileID_Result • StrikeIron_MobileID_StatusNbr • StrikeIron_MobileID_StatusDescription
Once the fields are created, you will click “Edit” to edit the Response Mappings and then “Add” to include additional mappings.
Map the following Response Attributes to your newly created fields. Make sure that you copy the Response Attribute (text string left of = sign) exactly as you see it here and make sure there are no spaces before or after the text
StrikeIron_MobileID_Result
StrikeIron_MobileID_StatusNbr
Save your Response Mappings by clicking “Save” at the bottom of the screen. The Webhook is now ready to be used by the Marketo system.
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.)
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.
Step 3: Create the Smart Campaign
This 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.
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).
Move on to the next tab, “Flow.” Drag “Call Webhook” onto the white canvas and choose the “SMS Notification” Webhook created in Step 1.
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."
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.
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.
As a test, fill out the lead form. When you click “Submit,” the lead will be entered in the Marketo Leads Database and the Smart Campaign will fire, performing the SMS Notification as configured in the Webhook. This will call the StrikeIron SMS API to deliver the notification message:
The notification will appear on the mobile device, having been delivered to the number configured in the Webhook in step 1.
Congratulations! You have successfully integrated StrikeIron’s SMS API into Marketo. You now have the ability to create SMS-enabled processes within the Marketo platform!