Connector for Marketo configuration properties
Implementing the Connector for Marketo requires a JSON configuration file, which defines your specific integration of Tridion Sites with Adobe Marketo Engage.
File structure
- MarketoConnector — defines the connector for Content Manager environment, including all user interfaces
- MarketoDeployConnector — defines the connector for all Content Delivery
Both connector deployments are defined in the file as sections at the connector level and both sections require the same general settings for connecting to Marketo. Additional settings are specific to Content Manager or Content Delivery.
General settings
The following settings must be included in both the MarketoConnector and MarketoDeployConnector sections:
- url
- The URL to the Marketo REST API endpoint.
- clientId
- API username to be used to authenticate over OAuth.
- clientSecret
- API password to be used to authenticate over OAuth.
- accountId
- The Marketo (Munchkin) Account ID.
- localeMapping
- A section that defines the mapping of Tridion Sites Publication IDs to Marketo locales.
Settings for Content Manager only
The MarketoConnector section also includes the following settings to configure Content Manager functionality:
- showDrafts
-
(Optional) A Boolean value (
true/false) that indicates whether to show or hide forms that are in the Draft status. - additionalLeadFields
-
(Optional) A list of additional fields that should be returned by the connector when using the GraphQL search endpoint for the
MarketoLeadentity type. This is useful for integration purposes with other components, such as Experience Optimization. - leadMemberships
-
(Optional) A list of the specific Marketo membership lists you want to retrieve when using the GraphQL search endpoint for the
MarketoLeadentity type. Because it's an expensive operation, this setting allows you to choose only the membership list you need. - enableLeadMembershipCaching
-
(Optional) A Boolean value (
true/false) that indicates whether to enable caching for the lead membership lists. When membership lists are selected to be retrieved, you can also specify if the values returned should be cached for a certain amount of time. - cacheExpiration
- (Optional) An expiration setting to use when membership caching is enabled. Define expiration in minutes.
Settings for Content Delivery only
The MarketoDeployerConnector section also includes the following settings to configure Content Delivery functionality:
- binaryAssetUploadFolderId
- The ID of the Marketo folder where binary assets (images and other binary files) will be uploaded. This will usually be under Design Studio > Images & Files
- binaryAssetNamePropertyMapping
- (Optional) Defines how to name binary Tridion assets that have been published to Marketo.
- snippetUploadFolderId
- The ID of the Marketo folder where snippets will be uploaded. This will usually be under Design Studio > Snippets
The following sample code illustrates the configuration file of a Connector for Marketo:
{
"configuration": {
"MarketoConnector": {
"configuration": {
"url": "https://123-EUC-123.mktorest.com",
"clientId": "123abc-123abc-123abc",
"clientSecret": "aFakeClientSecret_secret123",
"accountId": "123-EUC-123",
"localeMapping": [
{
"publicationIds": [ "6" ],
"locale": "source"
},
{
"publicationIds": [ "10" ],
"locale": "fr-FR"
},
{
"publicationIds": [ "11" ],
"locale": "de-DE"
}
],
"showDrafts": true,
"additionalLeadFields": [ "anonymousIP", "inferredCity", "department" ],
"leadMemberships": [ "staticList", "program", "smartCampaign" ],
"enableLeadMembershipCaching": true,
"cacheExpiration": 5
}
},
"MarketoDeployConnector": {
"configuration": {
"url": "https://123-EUC-123.mktorest.com",
"clientId": "123abc-123abc-123abc",
"clientSecret": "aFakeClientSecret_secret123",
"accountId": "123-EUC-123",
"localeMapping": [
{
"publicationIds": [ "6" ],
"locale": "source"
},
{
"publicationIds": [ "10" ],
"locale": "fr-FR"
},
{
"publicationIds": [ "11" ],
"locale": "de-DE"
}
],
"binaryAssetUploadFolderId": 1116,
"binaryAssetNamePropertyMapping": "Filename",
"snippetUploadFolderId": 1117
}
}
},
"sitesCm": {
"isEnabled": true,
"MarketoConnector": {
"namespaces": {
"mkt": {
"displayName": "Marketo",
"stubFolders": [ "tcm:2-70-2" ],
"privilegedUserName": "win-cr12votfo5o\\Administrator"
}
}
}
},
"staging": {
"isEnabled": true,
"MarketoConnector": {
"namespaces": {
"mkt": {}
}
},
"MarketoDeployConnector": {
"namespaces": {
"mktdeploy": {}
}
}
}
}