Skip to content

Instantly share code, notes, and snippets.

@WesleyDRobinson
Created July 19, 2017 23:01
Show Gist options
  • Save WesleyDRobinson/c45c84740d221e73abe39766e426123b to your computer and use it in GitHub Desktop.
Save WesleyDRobinson/c45c84740d221e73abe39766e426123b to your computer and use it in GitHub Desktop.
raw-marketo-docs

Getting Started

To start sending data to Marketo, there are two things you must do. Both of these steps require you to login with the Admin Marketo Account.

1. Enter your Marketo Credentials into your Destination settings. We'll need your Munchkin Account ID, Client Secret, and Client ID.

To get your Munchkin Account ID login to your Marketo account, click Admin in the top right corner, then click Munchkin on the left side bar.

To get your Client Secret and Client ID, you must create a role that has full API access, an API only user, and then create a Service in Marketo. To create a role with full API access:

  1. Click Admin in the top right corner.
  2. Click Users & Roles on the left side bar.
  3. Click on the Roles tab.
  4. Click New Role. Name your role and check the API Access box to assign the user full API access. Click Create.

Now that you've created an API role, you have to assign that role to an API only user.

  1. Click the Users tab.
  2. Click Invite New User and fill out the necessary information in Step 1.
  3. Assign the new role you created to this user in Step 2 and check the API Only box. Click next then Send.

Next, create a Service and get Client Secret and Client ID from that Service.

  1. Click LaunchPoint on the left side bar.

  2. Click New and then New Service from the drop down.

  3. Select Custom for the Service from the drop down.

  4. Select the new API Only user you invited. This User must be an API Only user and be assigned a role that has full API access.

  5. Click View Details on the new service that you've created and a small window will display with your Client Secret and Client ID. Copy and paste them into your Destination's Settings.

2. You must create a User ID and an Anonymous ID field in Marketo.

  1. Click Admin in the top right corner.
  2. Click Field Management on the left side bar.
  3. Click New Custom Field.
  4. Select String as the type.
  5. Name the field whatever you'd like.
  6. Set the API name to userId for the user ID field and then anonymousId for the anonymous ID field. Important: The API names for the user ID and anonymous ID fields must be userId and anonymousId exactly. If anything in the API name is different, the destination will not work.

Identify

When you call Identify, Segment uses Marketo's REST API to upsert leads. We'll map the following spec'd Segment traits to Marketo's standard fields:

Segment Traits Marketo Standard Fields
address.city City
address.counrty Country
address.zip Postal Code
address.state State
birthday Date Of Birth
company Company
email Email
firstName or name First
gender Marketo Social Gender
lastName or name Last
phone Phone

Here is a sample Javascript .identify() call with the all the standard traits:

analytics.identify('1234', {
  firstName: 'Robyn Rihanna',
  lastName: 'Fenty',
  email: '[email protected]',
  gender: 'woman',
  phone: '555-555-5555',
  company: 'Segment.com',
  birthday: '1988-02-20T00:00:00.000Z',
  createdAt: '2007-05-31T00:00:00.000Z',
  address: {
    city: "Eugene",
    country: "USA",
    postalCode: "97405",
    state: "Oregon"
  }
});

If you'd like any other traits from your .identify() call to update a field in Marketo, you must map them in your Destination settings.

  • Segment Trait. The name of the trait sent in your .identify() call.
  • Marketo Field Name. The Marketo REST API name for the field. To get the REST API name for your fields in Marketo, click Field Management, then Export Field Names. A spread sheet will download and the first column is the REST API name for your Marketo fields. Make sure to copy and paste the REST API name exactly. This is case sensitive.
  • Marketo Field Type. When you are in Field Management, click on the field name in the bar on the right and you'll see the field type.

Track

When you call Track, Segment maps the event to a pre-defined Marketo Custom Activity. There are two important things to note when sending .track() calls to Marketo:

  1. You must map them to your Marketo Custom Activities in your Destination Settings. If you do not map a track call to a Custom Activity in your Destination Settings, we will not send the event to Marketo to help limit the amount of API calls made to Marketo.

  2. You must either be in Cloud Mode or send track events from one of our server side libraries.

Here is a sample Ruby .track() event:

Analytics.track(
  event: 'Segment Event',
  properties: {
    firstName: 'Alex'
  }
)

  • Segment Event Name. Your Segment Event name.

  • Marketo Activity ID. When you are in Marketo Custom Activities, click on the Marketo Activity in the right side bar that you'd like to map your Segment Track event to. Copy and paste the ID into your Destination Settings.

  • Segment Property Name. The name of the property in your .track() call. This is case sensitive so make sure the name matches exactly how you are passing it in your .track() call.

  • Marketo Field Name. The name of the Marketo Attribute for your Custom Activity. The Attribute names for a given Custom Activity can be found in the Fields tab of Marketo Custom Attributes. Click on the Custom Activity in the right side bar and a list of your Attributes for that Custom Activity will appear. Make sure to copy and paste the API Name for your field exactly as it appears in Marketo. This is case sensitive.

  • Marketo Field Type. The type of the Marketo Attribute. The Attribute type can be found in the Fields tab of Marketo Custom Attributes. Click on the Custom Activity in the right side bar and a list of your Attributes for that Custom Activity will appear.

  • Primary Field. When creating a Custom Activity in Marketo, you have to set a Primary Field. If you are unsure which field was set as the primary field, when you are looking at the list of fields for your Custom Activity in Marketo, there will be a red star next to your Primary Field.

Page

When you call Page, Segment uses Marketo's Munchkin.js visitWebPage method. The URL is built from your .page() event and properties object into the form Marketo expects, so no need to worry about doing that yourself.

Marketo's visitWebPage method requires a URL and a user agent. Any calls that are missing either of these fields will not be sent to Marketo. User agent is automatically collected Client-side but if you are sending .page() calls from the server, make sure to set the user agent.

Here is a sample Node .page() event:

analytics.page({
  userId: '019mr8mf4r',
  category: 'Docs',
  name: 'Node.js Library',
  properties: {
    url: 'https://segment.com/docs/libraries/node',
    path: '/docs/libraries/node/',
    title: 'Node.js Library - Segment',
    referrer: 'https://github.com/segmentio/analytics-node'
  },
  context: {
    userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.115 Safari/537.36"
  }
});

Tracking Anonymous Activity in Marketo

If you would only like to track known users in Marketo, set your Track Anonymous Activity setting to false. There are a couple things to note when this setting is false:

  1. Any call without a User ID will be rejected.
  2. No anonymous activity will be sent to Marketo. Even after the user becomes known, none of their previous anonymous activity will be sent to Marketo.

If you'd like to track anonymous activity but don't want to have to parse through or view unknown leads, Marketo lets you create Smart Lists that will filter your leads (i.e. if you'd only like to view leads that have a user ID or an email). To do this, when you are in your Lead Database, click All Leads, then New. From the drop down, click New Smart List. Select the folder you'd like the Smart List to live in. After you've created the Smart List, select what field you'd like to filter by on the right side bar, drag it to the filters and then select what you'd specifically like to filter by for that field.

Marketo API Limits

We do our best to limit the amount of API calls that we are making to Marketo but if you are hitting your 50k/day limit, we’d recommend only sending events to Marketo that you need. To prevent an event from being sent to Marketo, you can select destinations by doing the following:

analytics.identify({
  userId: '97234974',
  traits: {
    firstName: 'Alex'
  },
  integrations: {
    'Marketo': false,
    'Google Analytics': true
  }
})

If that is not an option, you can also use Marketo V2 in Device Mode, however we strongly recommend using Marketo V2 in Cloud Mode. To understand the difference between Cloud and Device Mode for Marketo, check out Supported Sources and Connection Modes.

Preventing Duplicate Leads

Marketo allows you to upsert leads based on any field. We use email and userId as well as anonymousId if you are tracking anonymous activity. We will first use email since that is the field Marketo recommends is unique for your leads. However, many .track() and .page() calls don’t include an email address so then we will use the userId or anonymousId passed in your .track() and .page() calls to associate these events to leads in Marketo.

You can do one of the following to prevent duplicate leads:

  1. Recommended: Upload a CSV adding your userId to all your leads in Marketo before enabling the destination. After you’ve created the userId field in Marketo, you can upload a list of all your users with an email column and a userId column. Your CSV should look like this:
email userId
[email protected] ABC1234
[email protected] XYZ9876

To upload a list to Marketo, when you are in Lead Database, click All Leads. Then click “New”, then “Import List” from the drop down. Select your CSV, then click “Next”. Make sure “Email Address” and “userId” are the Marketo Fields selected then click “Next”. Name your list or select a pre-existing list. Select “None” for Acquisition Program. Then Click “Import”.

  1. Manually merge leads in Marketo. Follow these instructions to merge any duplicate leads found in Marketo after enabling the destination.
  2. Make sure to call identify first. This is already a recommended best practice as part of our spec.
  3. Pass an email in your .track() and .page() calls.

Migrating from Marketo to Marketo V2

There are a few necessary steps that have to be taken to Migrate from Marketo to Marketo V2.

Important: Make sure you disable Marketo once you are done getting set up with Marketo V2. If you leave both enabled, there will likely be duplicate data in your Marketo account.

  1. Your Marketo credentials in your Segment Destination settings need to be updated. Our Marketo Destination used Marketo's SOAP API and Marketo V2 uses Marketo's REST API which requires different credentials. Check out the Getting Started guide for what credentials you'll need.
  2. Two custom fields must be created in Marketo: userId and anonymousId. Check out Getting Started for exact details on how to create these custom fields in Marketo.
  3. Track calls must be mapped in your Destination settings. Our Marketo Destination sent track calls as a Munchkin Visit WebPage event in Marketo. In Marketo V2, we'll send your track calls to your Marketo Custom Activities. Detailed instructions here.
  4. If there are any custom Lead fields that you’d like sent to Marketo in your Identify calls, you must add them in your Destination settings. Detailed instructions here.
  5. Update anything in Marketo that rely on the way V1 sends .track() events to be triggered by your custom activities. For example, our V1 Marketo destination sent track events as a “Visit Web Page” event with /event/<your_event_name>. So if you a workflow that is triggered by a “Visit Web Page” event where the web page contains /event/<your_event_name>, you'll have to swap out the "Visit Web Page" event trigger you have with your Custom Attribute Trigger. In the right side bar, click the "Custom" folder under "Triggers" and select the trigger that you set for your custom activity:

To figure out what the trigger name for that Custom Activity is, navigate to the admin section of Marketo > Marketo Custom Activities > Click on your activity from the side bar and you'll see the trigger name:

  1. When enabling Marketo V2, because of the way Marketo’s API works, there is potential to create duplicate leads, especially when the first enabling the destination. For ways to prevent this, check out the Preventing Duplicate Leads.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment