Marketo Append Tool (SOAP API)
The Marketo Append tool retrieves Marketo records and appends them to the records of an incoming data stream. Two types of Marketo records can be retrieved:
- LeadRecord: These are lead records and there will be one record for each lead.
- ActivityRecord: These records track the activities for each lead. There can be many ActivityRecord records for each LeadRecord.
Both of these record types are retrieved by specifying a LeadKey, which must be supplied by an upstream tool. More information on LeadKeys can be found in the Append Tab section under Configuration Properties.
Configure the tool
There are three tabs for configuring the Marketo Append tool: Credentials, Append, and Output.
Credentials Tab
- Marketo SOAP API Endpoint (URL): Marketo location to retrieve records from. This information is found in Marketo (Admin > Integration > SOAP API).
- An Endpoint URL determines the version of the API used. Endpoint URLs can point to either a production or sandbox environment.
- Marketo User ID: User credential for Marketo access. This information is found in Marketo (Admin > Integration > SOAP API).
- Marketo Encryption Key: Additional credential supplied by Marketo. This information is found in Marketo (Admin > Integration > SOAP API).
Credentials can be saved or deleted from history.
Save: when clicked, the first 3 configuration settings will be saved and automatically populated each time the tool is used. If multiple Endpoints are used, each one will be available from the Endpoint dropdown list. Only one entry can be saved per Endpoint URL. Up to 10 sets of credentials can be saved.
Delete: will clear out the currently displayed credentials set and will be deleted from history.
Append Tab
- Select incoming field: Use the dropdown list of incoming data fields to specify which field is the LeadKey.
- Select incoming field type: Use the dropdown list to specify the type of LeadKey. The table below contains all of the possible LeadKey types.
Name |
API Name |
Email Address |
|
Marketo ID |
IDNUM |
Cookie |
COOKIE |
Lead Owner Email |
LEADOWNEREMAIL |
SFDC Account ID |
SFDCACCOUNTID |
SFDC Contact ID |
SFDCCONTACTID |
SFDC Lead ID |
SFDCLEADID |
SFDC Lead Owner ID |
SFDCLEADOWNERID |
SFDC Opportunity ID |
SFDCOPPTYID |
Note: Not all LeadKey types will work in all situations. For example, you can pull LeadRecords by Email Address, but not Activity Records. Attempting to pull Activity Records by email address will result in no results returned from Marketo.
Output Tab
- Select record type: Choose the type of records to retrieve and append to the incoming data stream. Choices are:
- LeadRecord: These are lead records and there will be one record for each lead.
- If This option is chosen, no more configuration options are available.
- ActivityRecord: These records track the activities for each lead. There can be many ActivityRecord records for each LeadRecord.
- If this option is chosen, additional filter options are available:
- Activity Filter: The user can optionally select from a check list of 57 activities. Choosing none is the same as choosing them all. Selecting All or None of the activity types will return all of them.
- Date Filter: A user can specify a starting or ending date. The time fields are optional in both cases and one or both can be set. If a starting date is specified, then all records on or after that date (and optional time) will be returned. If an ending date is specified, then all records up to that date (and optional time) will be returned. If a time is not specified, then midnight of the date provided is used (ie 00:00:00).
- Setting start date will give you everything after the specified date.
- Setting end date will give you everything before the specified date.
- Setting both dates will give you everything in between, but not including the exact start date.
- NOTE on datetime conversion between local and UTC time: All Marketo datetimes that you work with in Alteryx have been converted to Local Time (based on the TZ timezone settings of the local computer). So, whatever the machine is set for (timezone), is what is used to convert the datetimes. When the API call is made, the datetimes are converted to UTC time which is how Marketo stores the data. If Alteryx is used to pull records, you will always see Local Time and therefore you use Local Time to set these date filters. All of this hopefully makes it easier for the user who does not have to do any Local > UTC > Local conversions. They can work with their local time for all datetimes.
View the output
The fields that are output will always include the incoming fields first and then the Marketo fields. If the LeadKey value passed in is NULL, the tool will output a record with the input fields as specified along with all Marketo fields set to NULL. This type of record is also written if the LeadKey value is not found in Marketo (an email address that doesn't exist for example). You will always get at least one record out for every record you send into the tool.
Only fields that are non-null will be returned.
If the returned field has a Boolean datatype, only records that are True are returned. Marketo uses true and NULL for Boolean types instead of True/False.