Salesforce Interaction Studio Connector Setup Guide | Server-Side Connectors

API Information

This connector uses the following vendor API:

API Name: Personalization Event API
API Version: v2
Documentation: Personalization Event API

Connector Actions

Action Name	AudienceStream	EventStream
Send Event Data via Trusted Channel (SalesforceInteractions Namespace)	✗	✓
Send Event Data via Trusted Channel (Evergage Namespace)	✗	✓

Configure Settings

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article.

After adding the connector, configure the following settings:

Account Name
Required. Your Interaction Studio account name.
You can retrieve your account name by accessing Gears from the Interaction Studio UI in Salesforce and reviewing the URL. For example, if your Gears URL is https://demo.us-1.evergage.com/, then your account name is demo.
Instance Identifier
Required. Your Interaction Studio instance identifier.
You can retrieve your instance identifier by accessing Gears from the Interaction Studio UI in Salesforce and reviewing the URL. For example, if your Gears URL is https://demo.us-1.evergage.com/, then your instance identifier is us-1.
Dataset Identifier
Required. The name/identifier of the Interaction Studio dataset you are sending data to.
API Key ID
Required. Your API Key ID that will be used to generate an API Token.
For more information about API tokens, see the API Tokens documentation in the Salesforce Personalization Knowledge Base.
API Key Secret
Required. Your API Key Secret that will be used to generate an API Token.
For more information about API tokens, see the API Tokens documentation in the Salesforce Personalization Knowledge Base.

Click Done when you are finished configuring the connector.

Action Settings — Parameters and Options

Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Action — Send Event Data via Trusted Channel (SalesforceInteractions Namespace)

Parameters

Parameter	Description
Explain	If `true`, then return additional information in the response about why campaigns did or did not render.
Page View	If `true`, indicates that the event was triggered from a page load.
Time	The date and time of the event (in milliseconds) elapsed since the UNIX epoch. This field is optional and will be auto-populated with the current time if null.
Interaction Type	Select interaction type. Catalog Object Interaction - is used to capture engagement data about catalog objects. Cart Interaction - is used to capture engagement data about the contents of a user’s cart. Order Interaction - is used to capture engagement data about the items in a user’s order. In Personalization, only the PurchaseOrderInteraction affects and updates a user’s current order.
Interaction Name	Select interaction name. Names are displayed according to the selected Interaction Type.
ID	A unique ID representing the catalog object.
Type	A type name representing the catalog object.
Catalog Object Attributes	This section will be ignored if type selected in the Interaction Type section is not Catalog Object Interaction. Catalog Object Attributes are key-value pairs that are stored as metadata on the catalog object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
Related Catalog Objects	This section will be ignored if type selected in the Interaction Type section is not Catalog Object Interaction. Related catalog objects key-value pairs. These related catalog objects must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples.
Cart Data	This section will be ignored if type selected in the Interaction Type section is not Cart Interaction. This type of Interaction is used to capture engagement data about the contents of a user’s cart. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
Catalog Object ID	A unique ID representing the catalog object.
Catalog Object Type	The type representing the catalog object.
Currency	Optional currency code of purchase. Default to the dataset’s configured currency if null.
Price	The price of the catalog object in the line item.
Quantity	The number of catalog objects in the line item.
Cart Line Items Attributes	This section will be ignored if type selected in the Interaction Type section is not Cart Interaction. Cart Line Items Attributes are key-value pairs that are stored as metadata on the line item object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for object structure. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Cart Line Items Attributes arrays and Cart Line Items arrays must be of equal length. Single value attributes can be used and will apply to each item.
Cart Line Items Template Variables	Provide template variables as data input for Cart Line Items Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example: `items.name`. Nested template variables are typically built from data layer list attributes.
Cart Line Items Template	This section will be ignored if type selected in the Interaction Type section is not Cart Interaction. If you need nested objects support, use this section to define a template. The template expects a JSON object format if Add To Cart or Remove From Cart value is selected in the Interaction Name section. Otherwise the template expects a JSON array format. When template is defined, then configuration from the Cart Line Items and Cart Line Items Attributes sections will be ignored. You can use template variables mapped in the Cart Line Items Template Variables section. See Templates Guide documentation for more information about templates.
Order ID	ID of the purchased order.
Currency	Currency code of purchase.
Total Value	Total value for purchase.
Order Attributes	This section will be ignored if type selected in the Interaction Type section is not Order Interaction. Order Attributes are key-value pairs that are stored as metadata on the order object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
Catalog Object ID	A unique ID representing the catalog object.
Catalog Object Type	The type representing the catalog object.
Currency	Optional currency code of purchase. Default to the dataset’s configured currency if null.
Price	The price of the catalog object in the line item.
Quantity	The number of catalog objects in the line item.
Order Line Items Attributes	This section will be ignored if type selected in the Interaction Type section is not Order Interaction. Order Line Items Attributes are key-value pairs that are stored as metadata on the line item object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for object structure. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Order Line Items Attributes arrays and Order Line Items arrays must be of equal length. Single value attributes can be used and will apply to each item.
Order Line Items Template Variables	Provide template variables as data input for Order Line Items Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name`. Nested template variables are typically built from data layer list attributes.
Order Line Items Template	This section will be ignored if type selected in the Interaction Type section is not Order Interaction. If you need nested objects support, use this section to define a template. The template expects a JSON array format. When template is defined, then configuration from the Order Line Items and Order Line Items Attributes sections will be ignored. You can use template variables mapped in the Order Line Items Template Variables section. See Templates Guide documentation for more information about templates.
Provider	The consent provider.
Purpose	The purpose for the consent. For example, Personalization.
Status	The consent status. For example, OptIn or OptOut.
Test Messages	A comma-separated list of campaign experience IDs to be forced to return in the event, ignoring rules that would otherwise prevent the campaign from returning. Alternatively, you can use the string value true to return all campaigns in testing mode but all rules are respected.
No Campaigns	If `true`, do not return campaigns in the response.
Non Interactive	If `true`, a visit is not created (or updated) for the given user in the event. Additionally, no visit referrer nor originating referrer is created for the user.
Application	The originating application level source of the event. For example, ReactApp, 3rdParty, ReactNative.
Channel	The originating source of the event. For example, Web, MobileApp, CallCenter.
Client IP	The IP Address sending the event. `clientIp` is populated automatically but can be overwritten if necessary.
Config Version	Version number of the configuration for the SDK.
Content Zones	An array of content zones on the current page.
Device	Only applicable for mobile events.
Locale	The locale of the current page, as defined by ISO 639 alpha-2 language codes and ISO 3166 alpha-2 country codes. For example, en_US and de_DE.
Operating System	Only applicable for mobile events.
Operating System Version	Only applicable for mobile events.
Page Type	The type of page from which you are sending the event. For example, PDP, Blog, Pricing.
Survey ID	The ID of the survey being submitted. Set automatically for events sent through the Survey Gear.
Survey Start Time	The start time of the survey being submitted. Set automatically for events sent through the Survey Gear.
URL	The URL of the page from which you are sending the event.
URL Referrer	The previous URL visited by the user. `urlReferrer` is populated from `document.referrer` by default on the web. It can be overwritten in the sitemap to any other value if necessary.
User Agent	The user agent for the event. `userAgent` is populated automatically but can be overwritten if necessary.
Anonymous ID	The ID of an anonymous user.
Encrypted ID	The encrypted ID returned from an event that contains the ID field. Encrypted IDs are returned in the response to events that provide identities.
User Identities	User Identities are key-value pairs that are stored as identity information of a user. See Salesforce Interaction Studio Event API documentation for usage examples.
User Attributes	User Attributes are key-value pairs that are stored as metadata on the user. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
Profile Objects Template Variables	Provide template variables as data input for Profile Objects Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name`. Nested template variables are typically built from data layer list attributes.
Profile Objects Template	Provide template to send key-value pairs of profile objects that are stored as metadata on the user. Profile objects, their attributes, and related catalog objects must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON object format. You can use template variables mapped in the Profile Objects Template Variables section. See Templates Guide documentation for more information about templates.
ID	The ID of an account.
Account Attributes	Account Attributes are key-value pairs that are stored as metadata on the account. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
Network Time	Time, in milliseconds, for the previous request to return.
Page Load Time	Time, in milliseconds, for the DOM to load.
SDK Load Time	Time, in milliseconds, for the network to load the web SDK.
SDK Parse Time	Time, in milliseconds, for the beacon to be parsed during page load.
CampaignStat Array Template Variables	Provide template variables as data input for CampaignStat Array Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name` . Nested template variables are typically built from data layer list attributes.
CampaignStat Array Template	Provide template to send campaignStats array that is used to track campaign statistics for an associated event. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON array format. You can use template variables mapped in the CampaignStat Array Template Variables section. See Templates Guide documentation for more information about templates.
Template Variables	Provide template variables as data input for Templates. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name` . Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Event Data, Catalog Object Data, Catalog Object Attributes, Cart Data, Order Data, Order Attributes, Debug, Flags, Source, User Data, User Attributes, Account Data, Account Attributes and Performance Metrics sections. The template expects a valid JSON object format. See Templates Guide documentation for more information about templates. Templates are injected by name with double curly braces into supported fields. For example: `{{SomeTemplateName}}`.

Action — Send Event Data via Trusted Channel (Evergage Namespace)

Parameters

Parameter	Description
Item Action	Select the action taken on a catalog item. See Salesforce Interaction Studio Event API Item Actions documentation for supported item actions.
Action	Name of the event. Used for segmentation, targeting, and reporting.
Item Type	Required. Provide the type of the item to send `catalog` object.
Item Type	Required. Provide the type of the item to send `order` object.
Order ID	ID of the purchased order.
Currency	Currency code of purchase. Defaults to the dataset’s configured currency if null.
Total Value	Total value for purchase. Defaults to the sum of line items quantity * price.
ID	The ID of the item.
Price	The price of the item.
Quantity	The number of items.
Item Type	Required. Provide the type of the item to send `cart` object.
ID	The ID of the item.
Price	The price of the item.
Quantity	The number of items.
Provider	The consent provider.
Purpose	The purpose for the consent. For example, Personalization.
Status	The consent status. For example, OptIn or OptOut.
Explanations	If `true`, then return additional information in the response about why campaigns did or did not render.
Test Messages	A comma-separated list of campaign experience IDs to be forced to return in the event, ignoring rules that would otherwise prevent the campaign from returning. Alternatively, you can use the string value true to return all campaigns in testing mode but all rules are respected.
Do Not Track	If `true`, do not process the event one it is sent to the server.
No Campaigns	If `true`, do not return campaigns in the response.
Non Interactive	If `true`, a visit is not created (or updated) for the given user in the event. Additionally, no visit referrer nor originating referrer is created for the user.
Page View	If `true`, indicates that the event was triggered from a page load.
Application	The originating application level source of the event. For example, ReactApp, 3rdParty, ReactNative.
Channel	The originating source of the event. For example, Web, MobileApp, CallCenter.
Client IP	The IP Address sending the event. `clientIp` is populated automatically but can be overwritten if necessary.
Config Version	Version number of the configuration for the SDK.
Content Zones	An array of content zones on the current page.
Device	Only applicable for mobile events.
Locale	The locale of the current page, as defined by ISO 639 alpha-2 language codes and ISO 3166 alpha-2 country codes. For example, en_US and de_DE.
Operating System	Only applicable for mobile events.
Operating System Version	Only applicable for mobile events.
Page Type	The type of page from which you are sending the event. For example, PDP, Blog, Pricing.
Survey ID	The ID of the survey being submitted. Set automatically for events sent through the Survey Gear.
Survey Start Time	The start time of the survey being submitted. Set automatically for events sent through the Survey Gear.
Time	The date and time of the event, in milliseconds elapsed since the UNIX epoch. This field is optional and is auto-populated with the current time if null.
URL	The URL of the page from which you are sending the event.
URL Referrer	The previous URL visited by the user. `urlReferrer` is populated from `document.referrer` by default on the web. It can be overwritten in the sitemap to any other value if necessary.
User Agent	The user agent for the event. `userAgent` is populated automatically but can be overwritten if necessary.
Encrypted ID	The encrypted ID returned from an event that contains the ID field. Encrypted IDs are returned in the response to events that provide a `user.id`.
ID	The ID of a known user.
User Attributes	User Attributes are key-value pairs that are stored as metadata on the user. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
Profile Objects Template Variables	Provide template variables as data input for Profile Objects Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name`. Nested template variables are typically built from data layer list attributes.
Profile Objects Template	Provide template to send key-value pairs of profile objects that are stored as metadata on the user. Profile objects, their attributes, and related catalog objects must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON object format. You can use template variables mapped in the Profile Objects Template Variables section. See Templates Guide documentation for more information about templates.
ID	The ID of an account.
Account Attributes	Account Attributes are key-value pairs that are stored as metadata on the account. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: `{{template_name}}`.
DOM Load Time	Time, in milliseconds, for the DOM to finish loading.
Event DNS Time	Time, in milliseconds, to resolve account-specific domain.
Network Time	Time, in milliseconds, for the previous request to return.
Page Load Time	Time, in milliseconds, for the DOM to load.
SDK DNS Time	Time, in milliseconds, to perform resolution of SDK’s CDN domain.
SDK Load Time	Time, in milliseconds, for the network to load the web SDK.
SDK Parse Time	Time, in milliseconds, for the beacon to be parsed during page load.
CampaignStat Array Template Variables	Provide template variables as data input for CampaignStat Array Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name`. Nested template variables are typically built from data layer list attributes.
CampaignStat Array Template	Provide template to send campaignStats array that is used to track campaign statistics for an associated event. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON array format. You can use template variables mapped in the CampaignStat Array Template Variables section. See Templates Guide documentation for more information about templates.
Template Variables	Provide template variables as data input for Templates. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, `items.name`. Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Event Data, Catalog Data, Order Data, Cart Data, Debug, Flags, Source, User Data, User Attributes, Account Data, Account Attributes and Performance sections. The template expects a valid JSON object format. See Templates Guide documentation for more information about templates. Templates are injected by name with double curly braces into supported fields. For example: `{{SomeTemplateName}}`.