Tealium Learning Center

This article describes how to set up the Zoho Mail connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Email ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Client ID Follow https://www.zoho.com/mail/help/api/using-oauth-2.html#alink2. Third-Party app - Get Client ID and Client Secret and create OAuth2 credentials. Your authorized redirect URIs must be configured to allow redirect URI: https://my.tealiumiq.com/oauth/webhook/callback.html Client Secret See Client ID. Ensure pop-ups are not blocked, and click Establish Connection. Login to your account and confirm access. Once granted, ensure to save your Customer Data Hub profile. Anytime you go through this connection flow, ensure to save your Customer Data Hub profile to save your changes. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Email Parameters Parameter Description Account ID The unique Zoho account number associated with the particular account. For more information on this endpoint, visit: https://www.zoho.com/mail/help/api/post-send-an-email.html. Sender Address Valid sender email address corresponding to the account. To Address Valid recipient email address. cc Address Valid recipient email address. bcc Address Valid recipient email address Subject Subject of the email that should be sent. Content Content of the email. Encoding Default value is UTF-8. Other allowed encoding values are listed here: https://www.zoho.com/mail/help/api/post-send-an-email.html. Mail Format Whether the email should be sent in HTML format or in plain text. The default value is html. ... View more

This article describes how to use the HubSpot Workflow data source to create a webhook in your HubSpot account to send actionable events into EventStream. In this article: Table of Contents Placeholder Prerequisites HubSpot Marketing Professional, Sales Professional, or Enterprise account EventStream/AudienceStream account How It Works HubSpot offers a webhook API that sends outgoing requests to an endpoint that you specify. These requests act like push notifications to EventStream to inform it about things that happened in your HubSpot account. When you add the HubSpot data source in the UDH, a unique endpoint will be generated that you will use to configure the HubSpot webhook. Add the HubSpot Data Source Add the HubSpot data source before proceeding. (Learn how to add a data source). The HubSpot data source generates a unique URL to use as the HTTP POST URL in your HubSpot configuration. The URL generated is in the following format: https://collect-us-east-1.tealiumiq.com/integration/event/{account}/{profile}/{unique_id} Configuring HubSpot Once you have your data source endpoint, go to your HubSpot account to create the webhook. Log in to your HubSpot account. In your HubSpot Marketing Professional or Enterprise account, navigate to Contacts > Workflows. In your HubSpot Sales Professional account, navigate to Sales Tools > Workflows. Click the name of the workflow you'd like to edit. Click the plus (+ ) icon to add an action and in the right pane;and select Trigger a webhook. From the drop-down list, choose POST. Enter the following for the WebHook URL: https://collect-us-east-1.tealiumiq.com/integration/event/{account}/{profile}/{unique_id} Click Save. Events and Attributes All incoming HubSpot event attributes are automatically prefixed and underscored with hubspot_wf_ . For example, for properties.lead_source  =   hubspot_wf_properties_lead_source . The following table lists webhook events and attributes generated by HubSpot: Event Attribute Type Example hubspot_wf_vid String "3234574" hubspot_wf_canonical_vid String "3 234574 " hubspot_wf_portal_id String   "62515 " hubspot_wf_is_contact Boolean   " true " hubspot_wf_ profile_token String   "AO_T-mOFUify... " hubspot_wf_ profile_url String   " https://app.hubspot.com/ .. . " hubspot_wf_ properties_lead_source   String   "DiscoverOrg"   hubspot_wf_ properties_num_unique_conversion_events String   "0" hubspot_wf_ properties_hs_analytics_revenue String "0.0" hubspot_wf_ properties_createdate String "1484026585538" hubspot_wf_ properties_hs_email_optout String "true" hubspot_wf_ properties_hs_predictivecontactscore String "50" hubspot_wf_ properties_annualrevenue String   "181900000" hubspot_wf_ properties_hs_analytics_num_page_views String   "0" hubspot_wf_ properties_state String   "MA" hubspot_wf_ properties_zip String "02139" hubspot_wf_ properties_ hs _ predictability String "bucket_3"   hubspot_wf_ properties_ hubspotscore String "0" hubspot_wf_ properties_ linkedinconnections String "0" hubspot_wf_ properties_ hs _ lifecyclestage _subscriber_date String "1484026585538" hubspot_wf_ properties_ hs _analytics_average_page_views String "0" hubspot_wf_ properties_ lastname String "Huang" hubspot_wf_ properties_ twitterhandle String " ghidinelli " hubspot_wf_ properties_phone String "555-122-2323" hubspot_wf_ properties_ num _conversion_events String   "0" hubspot_wf_ properties_ currentlyinworkflow String "false" hubspot_wf_ properties_ hs _analytics_ num _event_completions String "2"   hubspot_wf_ properties_ followercount String "582" hubspot_wf_ properties_ associatedcompanyid String "184896670" hubspot_wf_ properties_ firstname String " Codey " hubspot_wf_ properties_city String "Cambridge" hubspot_wf_ properties_ hs _social_ num _broadcast_clicks String "0" hubspot_wf_ properties_ hs _analytics_ num _visits String "0" hubspot_wf_ properties_ twitterbio String "Racer, entrepreneur, world traveler..." hubspot_wf_ properties_hs_social_linkedin_clicks String   "0" hubspot_wf_ properties_hs_twitterid String "49019793" hubspot_wf_ properties_associatedcompanylastupdated String "13365279006997343" hubspot_wf_ properties_hs_analytics_source String "OFFLINE" hubspot_wf_ properties_company String "HubSpot" hubspot_wf_ properties_email String "testingapis@hubspot.com" hubspot_wf_ properties_linkedinbio String "Racecar driver, entrepreneur, world traveler..." hubspot_wf_ properties_website String " http://hubspot.com " hubspot_wf_ properties_address String "25 First Street" hubspot_wf_ properties_hs_analytics_first_timestamp String "1484026585538" hubspot_wf_ properties_lastmodifieddate String "1484858431084" hubspot_wf_ properties_photo String " https://d2ojpxxtu63wzl.cloudfront.net/st ..." hubspot_wf_ properties_hs_social_google_plus_clicks String "0" hubspot_wf_ properties_kloutscoregeneral String "48" hubspot_wf_ properties_hs_social_facebook_clicks String "0" hubspot_wf_ properties_twitterprofilephoto String " https://pbs.twimg.com/profile_images ..." hubspot_wf_ properties_hs_social_twitter_clicks String "0" hubspot_wf_ properties_hs_analytics_source_data_1   String "API" hubspot_wf_ properties_lifecyclestage String "subscriber" hubspot_wf_ associated_company_company_id String "184896670" hubspot_wf_ associated_company_portal_id String "62515" hubspot_wf_ associated_company_properties_country String "United States" hubspot_wf_ associated_company_properties_city String "Cambridge" hubspot_wf_ associated_company_properties_num_associated_contacts String "102" hubspot_wf_ associated_company_properties_timezone String "America/New_York" hubspot_wf_ associated_company_properties_facebook_company_page String " https://www.facebook.com/hubspot " hubspot_wf_ associated_company_properties_createdate String "1457708103847"   hubspot_wf_ associated_company_properties_description String "HubSpot is the world’s leading..." hubspot_wf_ associated_company_properties_industry String "COMPUTER_SOFTWARE" hubspot_wf_ associated_company_properties_total_money_raised String "$100.5M"   hubspot_wf_ associated_company_properties_days_to_close String "220" hubspot_wf_ associated_company_properties_hs_analytics_num_visits String "0" hubspot_wf_ associated_company_properties_linkedin_company_page String " http://www.linkedin.com/company/68529 " hubspot_wf_ associated_company_properties_recent_conversion_event_name String "Contact Us: excedalogic form" hubspot_wf_ associated_company_properties_hs_analytics_source String "OFFLINE"   hubspot_wf_ associated_company_properties_num_contacted_notes String "12"   hubspot_wf_ associated_company_properties_annualrevenue String "250000000" h ubspot_wf_ associated_company_properties_founded_year String "2006" hubspot_wf_ associated_company_properties_hs_analytics_num_page_views String "0" hubspot_wf_ associated_company_properties_state   String "MA" hubspot_wf_ associated_company_properties_linkedinbio String "HubSpot is the world’s leading..." hubspot_wf_ associated_company_properties_zip String "02141"   hubspot_wf_ associated_company_properties_notes_last_updated String "1480625888696" hubspot_wf_ associated_company_properties_website String "hubspot.com" hubspot_wf_ associated_company_properties_closedate String "1476768116137" hubspot_wf_ associated_company_properties_hs_analytics_first_timestamp String "1390574181854" hubspot_wf_ associated_company_properties_first_conversion_date   String "1477892839033" hubspot_wf_ associated_company_properties_engagements_last_meeting_booked String "" hubspot_wf_ associated_company_properties_first_contact_createdate   String "1390574181854" hubspot_wf_ associated_company_properties_twitterhandle String "HubSpot" hubspot_wf_ associated_company_properties_hs_lastmodifieddate String "1484854497180" hubspot_wf_ associated_company_properties_notes_last_contacted String "1479030015191" hubspot_wf_ associated_company_properties_phone String "+1 888-482-7768" hubspot_wf_ associated_company_properties_num_conversion_events String "40"   hubspot_wf_ associated_company_properties_domain String "hubspot.com" hubspot_wf_ associated_company_properties_is_public String "true" hubspot_wf_ associated_company_properties_name String "Hubspot, Inc."   hubspot_wf_ associated_company_properties_recent_conversion_date String   "1484844458500" hubspot_wf_ associated_company_properties_first_conversion_event_name String "excedalogic form" hubspot_wf_ associated_company_properties_num_notes   "12"   Vendor Documentation Using Webhooks in Workflows ... View more

This article describes how to set up the Salesmachine connector in your Customer Data Hub account. In this article" Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Create or Update a Contact ✓ ✗ Send Event ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Token You can find your Salesmachine project's API Credentials in “Administration > API Keys” in your Salesmachine dashboard. For more information, visit: https://docs.salesmachine.io/#install API Secret You can find your Salesmachine project's API Credentials under Administration > API Keys in your Salesmachine dashboard. For more information, visit: https://docs.salesmachine.io/#install. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create or Update a Contact Parameters Parameter Description Contact UID Unique identifier referring to a contact. It must match a unique ID in your application, like database ID or email address. For more information on this endpoint, visit: https://docs.salesmachine.io/#contact. Attributes Contact attributes to be added or updated. You can send any parameter, such as Title, Registered At, Position, and so on. Action - Send Event Parameters Parameter Description Contact UID Unique identifier referring to a contact. It must match a unique ID in your application like database ID or email address. For more information on this endpoint, visit: https://docs.salesmachine.io/#event. Event UID Event name. Event Data Additional attributes associated with the event. You can send any parameter. Salesmachine automatically detects parameter type. For timestamp, use seconds or milliseconds since Unix epoch (as an integer) or ISO 8601 dates as a string. ... View more

This article describes how to set up the Trumpia connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add Contact ✓ ✓ Add Contact to List ✓ ✓ Remove Contact From List ✓ ✓ Update Contact Data ✓ ✓ Delete Contact ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Key The API key is located in API Settings within the system. An API certification must be approved before a key is generated Reference the following API documentation for more information: https :// trumpia .com/ api /docs/ http /functions/contacts. php Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add Contact Parameters Parameter Description List Name The list to which the contact is to be added. First Name First name of the contact. Last Name Last name of the contact. Email Email address of the contact. One "tool" is required, for example, email or mobile number. Country Code Mobile phone number's country code. If left blank, then it will be assumed to be a U.S. number. Default value: 1. Mobile Number For U.S., the 10-digit number without the leading 0 or 1. For some international numbers, the leading 0 or 1 also must be omitted. No symbols or spaces. One "tool" is required, for example, email or mobile number. Send Verificiation True or false. If set to true, this sends a verification message to each tool before contacts are added to your distribution list. If the tool is not verified, it will be marked as not verified and cannot be used. If set to false, the verification step is bypassed and contacts will be added directly into your distribution list. A verification is omitted for an international phone number (not U.S.). Default value: false. Custom Verification Message Character limit of 60 characters. Default value: "Reply OK to start. Message and Data rates may apply. Upto 30 messages per month. Action - Add Contact to List Parameters Parameter Description Contact ID Unique ID of contact. For more information on this endpoint, see: https://trumpia.com/api/docs/http/functions/contacts.php. List Name The list to which the contact is to be added. Action - Remove Contact From List Parameters Parameter Description Tool Email address or mobile number depending on the tool_type selected. For more information on this endpoint, see: https://trumpia.com/api/docs/http/functions/contacts.php. Tool Type The list to contact information type. Value " 1 " = Email ; Value " 2 " = Mobile . Remove All True or false. By setting this flag to true, all other tools related to the specified tools will be deleted (the entire subscription will be deleted). Default value: false. List Name Distribution list name. If remove_all is true, then the contact will be removed from the particular distribution list. If no distribution list is specified, then the contact will be removed from all lists. Action - Update Contact Data Parameters Parameter Description Contact ID Unique ID of contact. For more information on this endpoint, see: https://trumpia.com/api/docs/http/functions/contacts.php. First Name First name of the contact. Last Name Last name of the contact. Email Email address of the contact. Country Code Mobile phone number's country code. If left blank, then it will be assumed to be a U.S. number. Default value: 1. Mobile Number For U.S., the 10-digit number without the leading 0 or 1. For some international numbers, the leading 0 or 1 also must be omitted. No symbols or spaces. Send Verificiation True or false. If set to true, this sends a verification message to each tool before contacts are added to your distribution list. If the tool is not verified, it will be marked as not verified and cannot be used. If set to false, the verification step is bypassed and contacts will be added directly into your distribution list. A verification is omitted for an international phone number (not U.S.). Default value: false. Custom Verification Message Character limit of 60 characters. Default value: "Reply OK to start. Message and data rates may apply. Upto 30 messages per month Action - Delete Contact Parameters Parameter Description Contact ID Unique ID of contact. For more information on this endpoint, see: https://trumpia.com/api/docs/http/functions/contacts.php. ... View more

This article describes how to set up the Woopra connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Track Event ✓ ✓ Update Visitor ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Track Event Parameters Parameter Description Project The name of your project in Woopra. For more information on this endpoint, visit: https://docs.woopra.com/reference#section-endpoint-http-s-www-woopra-com-track-ce-. Cookie The cookie should be thought of as a device ID. It can also be used for anonymous IDs. Required if no cv_{Visitor Identifier} . Event The name of the custom event you are tracking. Timestamp Event timestamp, formatted in milliseconds since Unix epoch that the event occurred. (This can be back-dated, but not in the future.) Visitor Identifier Type Email, phone number, etc. Required if using Visitor Identifier. Visitor Identifier An identifier or multiple identifiers to associate with this visitor. Required if no cookie. Each key must be prepended with " cv_ ": for example, " cv_email ". For more information on this format, visit: https://docs.woopra.com/reference#track-ce. Visitor Properties Properties to set on the visitor's profile. These can be strings, numbers, dates, etc. Each key must be prepended with " cv_ ": for example, " cv_first_name " or " cv_title ". For more information on this format, visit: https://docs.woopra.com/reference#track-ce. Event Properties Properties to set on the custom event. These can be strings, numbers, dates, etc. Each key must be prepended with " ce_ ": for example, " ce_total_value " or " ce_purchase_date ". For more information on this format, visit: https://docs.woopra.com/reference#track-ce. Visit Properties Properties to set on the visit or session. These can be strings, numbers, dates, etc. Each key must be prepended with " cs_ ": for example, " cs_is_work_computer " or " cs_mobile_web ". For more information on this format, visit: https://docs.woopra.com/reference#track-ce. Referer Visit's referring URL. Woopra servers will match the URL against a database of referrers, and will generate a referrer type and search terms when applicable. The referrers data will be automatically accessible from the Woopra interface. IP Address IP address of the visitor. If defined, it overrides the physical IP address of the connection. Timeout In milliseconds. Defaults to 30000 (equivalent to 30 seconds), after which the event will expire and the visit will be marked as over, and the visitor as offline. Browser User's browser. If defined, it overrides the auto-detected browser from the request's user-agent. You can also build your custom user-agent. Operating System User's operating system. If defined, it overrides the auto-detected browser from the request's user-agent. You can also build your custom user-agent. Device User's device type. If defined, it overrides the auto-detected device type from user-agent. Common values are mobile, tablet and desktop. Action - Update Visitor Parameters Parameter Description Project The name of your project in Woopra. For more information on this endpoint, visit: https://docs.woopra.com/reference#track-identify. Cookie The cookie should be thought of as a device ID. It can also be used for anonymous IDs. Required if no   cv_{Visitor Identifier} . Visitor Identifier Type Email, phone number, etc. Required if using Visitor Identifier. Visitor Identifier An identifier or multiple identifiers to associate with this visitor. Required if no cookie. Each key must be prepended with " cv_ ": for example, " cv_email ". For more information on this format, visit: https://docs.woopra.com/reference#-identify. Visitor Properties Properties to set on the visitor's profile. These can be strings, numbers, dates, etc. Each key must be prepended with "  cv_ ": for example, "  cv_first_name " or "  cv_title ". For more information on this format, visit: https://docs.woopra.com/reference#track-identify. ... View more

This article describes how to set up the Freshsales connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Create a Lead ✓ ✓ Convert a Lead ✓ ✓ Update a Lead ✓ ✓ Delete A Lead ✓ ✓ Create a Contact ✓ ✓ Update Contact ✓ ✓ Delete a Contact ✓ ✓ Create an Account ✓ ✓ Update an Account ✓ ✓ Delete an Account ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Company Domain The company subdomain name preceding  freshsales.io  in your login URL. Example: COMPANY_DOMAIN.freshsales.io . Do not include http:// or https:// API Key: To find your API key: click your profile picture and select Profile Settings, then click the API Settings tab. You can find your API key in the field "Your API key". Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create a Lead Parameters Parameter Description Last Name Last name of the lead. For information about this endpoint, see: https://www.freshsales.io/api/#create_lead. First Name First name of the lead. Job Title Designation of the lead in the company they belong to. Department The department that the lead belongs to. Email Primary email address of the lead. Work Phone Work phone number of the lead. Mobile Phone Mobile phone number of the lead. Address Address of the lead. City City that the lead belongs to. State State that the lead belongs to. Zipcode Zipcode of the region that the lead belongs to. Country Country that the lead belongs to. Lead Stage ID ID of the lead stage that the lead belongs to. Lead Reason ID ID of the lead reason: that is, the reason to unqualify the lead. Can be set only if the lead is in "Unqualified" stage. Lead Source ID ID of the source where lead came from. Owner ID ID of the user to whom the lead has been assigned. Has Authority Whether the lead has authority to take decisions regarding the purchase. Possible values: true or false. Do Not Disturb Whether the lead has enabled do not disturb, or unsubscribed from your emails. Possible values: true or false. Medium The medium that led your lead to your website or app. Campaign ID The campaign that led your lead to your website or app. Must be an existing Campaign in Freshsales. Keyword The keywords that the lead used to reach your website or app. Timezone Timezone that the lead belongs to. Facebook Account Facebook account of the lead. Twitter Account Twitter account of the lead. Linkedin Account LinkedIn account of the lead. Territory ID ID of the territory that the lead belongs to. Company Name Name of the company that the lead belongs to. Company Address Address of the company that the lead belongs to. Company City City that the lead's company belongs to. Company State State that the lead's company belongs to. Company Zipcode Zipcode of the region that the lead's company belongs to. Company Country Country that the lead's company belongs to. Company Industry Type ID ID of the industry that the lead's company belongs to. Company Business Type ID ID of the business that the lead's company belongs to. Company Number of Employees Number of employees in the lead's company. Possible values (in left column): 1 = " 1-10 " 11 = " 11-50 " 51 = " 51-200 201 = " 201-500 " 501 = " 501-1000 " 1001 = "1 001-5000 " 5001 = " 5001-10000 " 10001 = "10000+ " Company Annual Revenue Annual revenue of the lead's company. Company Website Website of the lead's company. Company Phone Phone number of the lead's company. Deal Name Name of the lead's deal. Deal Amount Value of the lead's deal in dollars. Deal Expected Close Date The date when the lead's deal is expected to close. Deal Product ID ID of the product that the lead's deal belongs to (in a multi-product company). Created Date Lead creation timestamp. Updated Date Lead updated timestamp. Custom Fields Map additional custom fields for the lead. Custom fields must already exist in Freshsales. You must also prepend ' cf_ ' to the field name. For example, when mapping a value to a custom field called ' custom1 ', you must use ' cf_custom1' as the field name. Action - Convert a Lead Parameters Parameter Description Last Name Last name of the lead. For information about this endpoint, see: https://www.freshsales.io/api/#lead_convert. Company Name Name of the company that the lead belongs to. Lead ID Freshsales ID for an existing lead. For information on fetching existing leads, see: https://www.freshsales.io/api/#list_all_leads. First Name First name of the lead. Job Title Designation of the lead in the company they belong to. Department The department that the lead belongs to. Email Primary email address of the lead. Work Phone Work phone number of the lead. Mobile Phone Mobile phone number of the lead. Address Address of the lead. City City that the lead belongs to. State State that the lead belongs to. Zipcode Zipcode of the region that the lead belongs to. Country Country that the lead belongs to. Lead Stage ID ID of the lead stage that the lead belongs to. Lead Reason ID ID of the lead reason: that is, reason to unqualify the lead. Can be set only if the lead is in "Unqualified" stage. Lead Source ID ID of the source where lead came from. Owner ID ID of the user to whom the lead has been assigned. Has Authority Whether the lead has authority to take decisions regarding the purchase. Possible values: true or false. Do Not Disturb Whether the lead has enabled do not disturb, or unsubscribed from your emails. Possible values: true or false. Medium The medium that led your lead to your website or web app. Campaign ID The campaign that led your lead to your website or web app. Must be an existing Campaign in Freshsales. Keyword The keywords that the lead used to reach your website or web app. Timezone Timezone that the lead belongs to. Facebook Account Facebook account of the lead. Twitter Account Twitter account of the lead. Linkedin Account LinkedIn account of the lead. Territory ID ID of the territory that the lead belongs to. Company Address Address of the company that the lead belongs to. Company City City that the lead's company belongs to. Company State State that the lead's company belongs to. Company Zipcode Zipcode of the region that the lead's company belongs to. Company Country Country that the lead's company belongs to. Company Industry Type ID ID of the industry that the lead's company belongs to. Company Business Type ID ID of the business that the lead's company belongs to. Company Number of Employees Number of employees in the lead's company. Possible values (in left column):  1  = "   1-10 "   11  = "   11-50 "   51  = "   51-200 201  = "   201-500 "   501  = "   501-1000 "   1001  = "1   001-5000 "   5001  = "   5001-10000 "  10001 = "10000+ " Company Annual Revenue Annual revenue of the lead's company. Company Website Website of the lead's company. Company Phone Phone number of the lead's company. Deal Name Name of the lead's deal. Deal Amount Value of the lead's deal in dollars. Deal Expected Close Date The date when the deal is expected to close. Deal Product ID ID of the product that the lead's deal belongs to (in a multi-product company). Created Date Lead creation timestamp. Updated Date Lead updated timestamp. Action - Update a Lead Parameters Parameter Description Lead ID Freshsales ID for an existing lead. For information about this endpoint, see: https://www.freshsales.io/api/#update_lead. Last Name Last name of the lead. First Name First name of the lead. Job Title Designation of the lead in the company they belong to. Department The department that the lead belongs to. Email Primary email address of the lead. Work Phone Work phone number of the lead. Mobile Phone Mobile phone number of the lead. Address Address of the lead. City City that the lead belongs to. State State that the lead belongs to. Zipcode Zipcode of the region that the lead belongs to. Country Country that the lead belongs to. Lead Stage ID ID of the lead stage that the lead belongs to. Lead Reason ID ID of the lead reason: that is, reason to unqualify the lead. Can be set only if the lead is in "Unqualified" stage. Lead Source ID ID of the source where lead came from. Owner ID ID of the user to whom the lead has been assigned. Has Authority Whether the lead has authority to take decisions regarding the purchase. Possible values: true or false. Do Not Disturb Whether the lead has enabled do not disturb, or unsubscribed from your emails. Possible values: true or false. Medium The medium that led your lead to your website or web app. Campaign ID The campaign that led your lead to your website or web app. Must be an existing Campaign in Freshsales. Keyword The keywords that the lead used to reach your website or web app. Timezone Timezone that the lead belongs to. Facebook Account Facebook account of the lead. Twitter Account Twitter account of the lead. Linkedin Account LinkedIn account of the lead. Territory ID ID of the territory that the lead belongs to. Company Name Name of the company that the lead belongs to. Company Address Address of the company that the lead belongs to. Company City City that the lead's company belongs to. Company State State that the lead's company belongs to. Company Zipcode Zipcode of the region that the lead's company belongs to. Company Country Country that the lead's company belongs to. Company Industry Type ID ID of the industry that the lead's company belongs to. Company Business Type ID ID of the business that the lead's company belongs to. Company Number of Employees Number of employees in the lead's company. Possible values (in left column):  1  = "   1-10 "   11  = "   11-50 "   51  = "   51-200 201  = "   201-500 "   501  = "   501-1000 "   1001  = "1   001-5000 "   5001  = "   5001-10000 "  10001 = "10000+ " Company Annual Revenue Annual revenue of the lead's company. Company Website Website of the lead's company. Company Phone Phone number of the lead's company. Deal Name Name of the lead's deal. Deal Amount Value of the lead's deal in dollars. Deal Expected Close Date The date when the deal is expected to close. Deal Product ID ID of the product that the lead's deal belongs to (in a multi-product company). Created Date Lead creation timestamp Updated Date Lead updated timestamp Custom Fields Map additional custom fields for the lead. Custom fields must already exist in Freshsales. You must also prepend cf_  to the field name. For example, when mapping a value to a custom field called ' custom1 ', you must use ' cf_custom1 ' as the field name. Action - Delete A Lead Parameters Parameter Description Lead ID Freshsales ID for an existing lead. For information about this endpoint, see: https://www.freshsales.io/api/#delete_a_lead. Action - Create a Contact Parameters Parameter Description Last Name Last name of the lead. For information about this endpoint, see: https://www.freshsales.io/api/#create_contact. First Name First name of the contact. Job Title Designation of the contact in the company they belong to. Department The department that the contact belongs to. Email Primary email address of the contact. Work Phone Work phone number of the contact. Mobile Phone Mobile phone number of the contact. Address Address of the contact. City City that the contact belongs to. State State that the contact belongs to. Zipcode Zipcode of the region that the contact belongs to. Country Country that the contact belongs to. Sales Account ID Existing Account ID that the contact belongs to. New Account Name New sales account to create and associate the contact to. Territory ID ID of the territory that the contact belongs to. Lead Source ID ID of the source where contact came from. Owner ID ID of the user to whom the contact has been assigned. Has Authority Whether the contact has authority to take decisions regarding the purchase. Possible values: true or false. Do Not Disturb Whether the contact has enabled do not disturb, or unsubscribed from your emails. Possible values: true or false. Medium The medium that led your contact to your website or web app. Campaign ID The campaign that led your contact to your website or web app. Must be an existing Campaign in Freshsales. Keyword The keywords that the contact used to reach your website or web app. Timezone Timezone that the contact belongs to. Facebook Account Facebook account of the contact. Twitter Account Twitter account of the contact. Linkedin Account LinkedIn account of the contact. Created Date Contact creation timestamp. Updated Date Contact updated timestamp. Contact Status ID ID of the contact status that the contact belongs to. Custom Fields Map additional custom fields for the contact. Custom fields must already exist in Freshsales. You must also prepend ' cf_ ' to the field name. For example, when mapping a value to a custom field called ' custom1 ', you must use ' cf_custom1 ' as the field name. Action - Update Contact Parameters Parameter Description Contact ID Freshsales ID for an existing contact. For information on this endpoint, see: https://www.freshsales.io/api/#update_a_contact. Last Name Last name of the lead. First Name First name of the contact. Job Title Designation of the contact in the company they belong to. Department The department that the contact belongs to. Email Primary email address of the contact. Work Phone Work phone number of the contact. Mobile Phone Mobile phone number of the contact. Address Address of the contact. City City that the contact belongs to. State State that the contact belongs to. Zipcode Zipcode of the region that the contact belongs to. Country Country that the contact belongs to. Sales Account ID Existing Account ID that the contact belongs to. Territory ID ID of the territory that the contact belongs to. Lead Source ID ID of the source where contact came from Owner ID ID of the user to whom the contact has been assigned Has Authority Whether the contact has authority to take decisions regarding the purchase. Possible values: true or false. Do Not Disturb Whether the contact has enabled do not disturb, or unsubscribed from your emails. Possible values: true or false. Medium The medium that led your contact to your website or web app. Campaign ID The campaign that led your contact to your website or web app. Must be an existing Campaign in Freshsales. Keyword The keywords that the contact used to reach your website or web app. Timezone Timezone that the contact belongs to. Facebook Account Facebook account of the contact. Twitter Account Twitter account of the contact. Linkedin Account LinkedIn account of the contact. Created Date Contact creation timestamp. Updated Date Contact updated timestamp. Contact Status ID ID of the contact status that the contact belongs to. Custom Fields Map additional custom fields for the contact. Custom fields must already exist in Freshsales. You must also prepend ' cf_ ' to the field name. For example, when mapping a value to a custom field called ' custom1 ', you must use ' cf_custom1 ' as the field name. Action - Delete a Contact Parameters Parameter Description Contact ID Freshsales ID for an existing contact. For information about this endpoint, see: https://www.freshsales.io/api/#delete_a_contact. Action - Create an Account Parameters Parameter Description Account Name Name of the account. For information on this endpoint, see: https://www.freshsales.io/api/#create_account. Address Address of the account. City City that the account belongs to. State State that the account belongs to. Zipcode Zipcode of the region that the account belongs to. Country Country that the account belongs to. Industry Type ID ID of the industry that the account belongs to. Business Type ID ID of the business that the account belongs to. Number of Employees Number of employees in the account. Possible values (in left column):  1  = "   1-10 "   11  = "   11-50 "   51  = "   51-200 201  = "   201-500 "   501  = "   501-1000 "   1001  = "1   001-5000 "   5001  = "   5001-10000 "  10001 = "10000+ " Annual Revenue Annual revenue of the account. Website Website of the account. Phone Number Phone number of the account. Owner ID ID of the user to whom the account has been assigned. Facebook Facebook account of the account. Twitter Twitter account of the account. Linkedin LinkedIn account of the account. Territory ID ID of the territory that the account belongs to. Created Date Account creation timestamp. Updated Date Account updated timestamp. Parent Sales Account ID Parent account ID of the account. Custom Fields Map additional custom fields for the account. Custom fields must already exist in Freshsales. ou must also prepend ' cf_ ' to the field name. For example, when mapping a value to a custom field called ' custom1 ', you must use ' cf_custom1 ' as the field name. Action - Update an Account Parameters Parameter Description Account ID Freshsales ID for an existing account. For information on this endpoint, see: https://www.freshsales.io/api/#update_a_account. Account Name Name of the account. Address Address of the account. City City that the account belongs to. State State that the account belongs to. Zipcode Zipcode of the region that the account belongs to. Country Country that the account belongs to. Industry Type ID ID of the industry that the account belongs to. Business Type ID ID of the business that the account belongs to. Number of Employees Number of employees in the account. Possible values (in left column):  1  = "   1-10 "   11  = "   11-50 "   51  = "   51-200 201  = "   201-500 "   501  = "   501-1000 "   1001  = "1   001-5000 "   5001  = "   5001-10000 "  10001 = "10000+ " Annual Revenue Annual revenue of the account. Website Website of the account. Phone Number Phone number of the account. Owner ID ID of the user to whom the account has been assigned. Facebook Facebook account of the account. Twitter Twitter account of the account. Linkedin LinkedIn account of the account. Territory ID ID of the territory that the account belongs to. Created Date Account creation timestamp. Updated Date Account updated timestamp. Parent Sales Account ID Parent account id of the account. Custom Fields Map additional custom fields for the account. Custom fields must already exist in Freshsales. You must also prepend ' cf_ ' to the field name. For example, when mapping a value to a custom field called ' custom1 ', you must use ' cf_custom1 ' as the field name. Action - Delete an Account Parameters Parameter Description Account ID Freshsales ID for an existing account. For information on this endpoint, see: https://www.freshsales.io/api/#delete_a_account. ... View more

This article describes how to set up the Delighted connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Survey ✓ ✓ Unsubscribe a User ✓ ✗ Delete a User ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Key: To use the Delighted API, you’ll need a private API key that is linked to your account. For more information, visit: https ://delighted.com/docs/ api. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Survey Parameters Parameter Description Email Email of the person (required if phone_number is not provided). For more information, visit: https://delighted.com/docs/api/sending-to-people. Phone Number Phone number of the person (required if channel is sms). The phone number format must be E.164 (for example, +17132746524). The value should start with a + followed by the country code and then the number. The value should contain only + and digits, no spaces or other punctuation. Channel Survey channel. Specify sms and provide a phone_number to have the survey request sent via SMS. Specify email, or leave out the option, to have the survey request sent via email. Name Name of the person. Delay The amount of seconds to wait before sending the survey email. The default is 0 (that is, it will send immediately). This parameter will be ignored if you set send=false. There is no maximum delay. Properties Custom properties to associate with the survey. You can add as many properties as you need, but they must be existing properties you've set up in your Delighted instance. For more information on how to set up Properties in Delighted, visit: https://help.delighted.com/article/114-setting-up-properties-in-delighted. Send True or false. Set to false if you do not want to send a survey email. The default is true. Last Sent At An optional Unix timestamp to manually set the time a person was most recently sent a survey. This value will be considered by the survey throttling system. Formatting example (for a recent date): 1540321023. Action - Unsubscribe a User Parameters Parameter Description Email The email of the user to be unsubscribed. For more information on this endpoint, visit: https://delighted.com/docs/api/unsubscribing-people. Action - Delete a User Parameters Parameter Description Identifier You can specify the person to delete by ID, email, or phone number (in E.164 format). For more information on this endpoint, visit: https://delighted.com/docs/api/deleting-people. ... View more

This article describes how to set up the Mailerlite connector in your Customer Data Hub account. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send, Schedule or Cancel Campaign ✓ ✓ Add a New Subscriber ✓ ✓ Update a Subscriber ✓ ✗ Add a Subscriber to a Group ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Key Every request to MailerLite API should contain a valid API key. Your API key can be obtained from the Integrations page when you are logged into the MailerLite application. For more information, visit: https ://developers. mailerlite .com/docs/authentication . Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send, Schedule or Cancel Campaign Parameters Parameter Description ID ID of campaign. Action Action type. Possible values: send, cancel. Every action is active due to some conditions. For more information on these conditions, visit: https://developers.mailerlite.com/reference#campaign-actions-and-triggers. Type Possible values: 1 to send instantly (default value), 2 to schedule send. Follow-Up Schedule Possible values: 24h = followup mail to be sent in 24 hours (default value), specific = must provide custom time. Analytics Possible values: 0 for false, 1 for true. Date Format: yyyy-mm-dd H:i. Available when type is 2. Timezone ID ID of timezone. Available when type is 2. Follow-Up Date Format: yyyy-mm-dd H:i. Available only for followup campaigns when followup_schedule is specific. Follow-Up Timezone ID ID of timezone. Available only for followup campaigns when followup_schedule is specific. Action - Add a New Subscriber Parameters Parameter Description Email Email of the new subscriber. For more information on this endpoint, visit: https://developers.mailerlite.com/reference#create-a-subscriber. Name Name of the new subscriber. Fields Custom data fields. For example: company, city, state, and so on. Resubscribe True or false. Reactivates subscriber if value is true. Type Available values: subscribed, active, unconfirmed. Signup IP   Signup Timestamp UTC only. Format Y-m-d H:i:s. Confirmation IP   Confirmation Timestamp Only UTC, format Y-m-d H:i:s Action - Update a Subscriber Parameters Parameter Description Identifier ID or email of subscriber. For more information on this endpoint, visit: https://developers.mailerlite.com/reference#update-subscriber. Name Subscriber's name. Type Available values: unsubscribed, active. Fields Additional fields to be updated. Resend Autoresponders True or false. Defines if it is needed to resend autoresponders. Action - Add a Subscriber to a Group Parameters Parameter Description ID ID of the group. For more information on this endpoint, visit: https://developers.mailerlite.com/reference#add-single-subscriber. Email Email of new subscriber. Name Name of subscriber. Fields Custom fields. For example: company, city, state, and so on. Resubscribe True or false. Reactivate subscriber if value is true. Autoresponders True or false. Autoresponders will be sent if value is true. Type Available values: unsubscribed, active, unconfirmed. ... View more

This article describes how to set up the Optimizely Events connector in your Customer Data Hub account. The Beta version of this connector is currently available as an Experiment. (Learn more). This version can still be used if you already have it configured in your system but is no longer available in the marketplace. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Event ✗ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Personal Token To authenticate, use a token in the request header generated from the following link: http://app.optimizely.com/v2/profile/api. All API request examples in this documentation use the same header. For more information on authentication, see Personal Token. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Event Parameters Parameter Description Account ID The Optimizely account to which these events should be attributed. Enrich Decisions Values are true or false. Should be set to true to enable the Optimizely Easy Event Tracking functionality. For more information about this field, see the Event API reference. See also How Optimizely counts conversions. Campaign ID Required The ID of the campaign containing this experiment. Experiment ID Required The ID of the experiment the visitor was exposed to. For Personalization Campaigns, explicitly send "null" as the Experiment ID for visitors not bucketed into an Experiment, in order to accurately calculate Campaign reach. Variation ID Required The ID of the variation the visitor was exposed to. For Personalization Campaigns, explicitly send "null" as the Variation ID for visitors not bucketed into any Experiment in order to accurately calculate campaign reach. Is Campaign Holdback Values are true or false. If true, the chosen experience was held back at the campaign level. Required for Personalization, omit otherwise. Timestamp Required Timestamp at which the event was generated, formatted in milliseconds since Unix epoch. Sends a {{unixTimestampMs}} by default if no value is provided by the user. UUID Required A unique identifier for this event. Created automatically using {{uuid}} . Used by Optimizely's backend to de-duplicate requests that are accidentally or erroneously replayed. Optimizely detects events that have the same entity_id , uuid and timestamp and saves only one of them. Ensure that each event uses a unique uuid or timestamp before sending. Entity ID Optional The ID of the entity corresponding to this attribute. Only required for custom attributes ( type="custom" ). Invalid for other attribute types. Event Name The event key (aka API name) for this event. Event Data Additional event data in key-value pairs. Tags Optional. Key-value attributes related to tags. If used, type and value must be included as two of the keys. Event Type The type of event. For example, to indicate a decision_point , type should be campaign_activated . Event Value A scalar value associated with an event. This should be some non-revenue number. Visitor ID Required A unique identifier for the visitor. Attributes Attributes associated with this visitor at the time of this request. Session ID A unique identifier that identifies the session context, if any, for these events. If omitted, the Optimizely backend calculates session-based results by inferring sessions and opening a session when an event is first received from a given visitor_id , and closing the session after 30 minutes with no events received for that visitor. Maximum session size is 24 hours. Anonymize IP Optimizely typically stores the client IP address for each request. Values are true or false. If this flag is set to true, the last octet of the IP address is truncated before it is stored. If set to false, the entire IP address is stored. Most relevant for consumers of this API that are implemented in a web browser or mobile client context and are subject to policies or regulations restricting the storage of end-user identifying information. This flag is independent of the IP anonymization setting in the Account and Project settings, which only controls how Optimizely clients set this flag. If this flag is set, care must be taken when using the IP filtering features, as fully-qualified explicit IP addresses will not function as filters (anonymization occurs before events are filtered by IP). Client Name Recommended for debugging purposes. A unique identifier for the system that generated this event. By convention, should be similar to the following example: organization_name/system_name For a complete description of the Event API, see the Event API reference. Client Version Recommended for debugging purposes. A version identifier for the system that generated this event. Project ID Optional. The Project ID needs only to be passed if you are using the Recommendations product. ... View more

This article describes how to set up the ReferralCandy connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Signup Advocate ✓ ✓ Invite Advocate ✓ ✓ Register a Purchase ✗ ✓ Update Status of Referred Purchase ✗ ✓ Unsubscribe an Advocate ✓ ✓ Resubscribe an Advocate ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Access ID Your API access ID can be found in the "API Tokens" section of your profile page at https://my.referralcandy.com/settings. API Secret Key Your API secret key can be found in the "API Tokens" section of your profile page at   https://my.referralcandy.com/settings. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Signup Advocate Parameters Parameter Description Email Address Advocate's email address. For information on this endpoint, see: https://www.referralcandy.com/api#signup. First Name Advocate's first name. Last Name Advocate's last name. Action - Invite Advocate Parameters Parameter Description Email Address Email address to send the invite to. For information on this endpoint, see: https://www.referralcandy.com/api#invite. Action - Register a Purchase Parameters Parameter Description Email Address Customer's email address. For information on this endpoint, see: https://www.referralcandy.com/api#purchase. First Name Customer's first name. Last Name Customer's last name Customer's Language Customer's preferred language. Defaults to campaign's default language if it is not set or not available to the campaign. Possible values: en, fr, de, es, it, ja, nl, ru, zh-CN, zh-HK, zh-TW, da, no, sv, pt-BR. Discount Code Discount code used in the order. Accepts Marketing Whether the customer-opted in to marketing. Possible values: true or false. Defaults to true. Order Timestamp Unix timestamp of order. If not provided, current Unix timestamp will be used. Browser IP IP address of customer when making the purchase. User Agent User agent string of the customer's web browser. Invoice Amount Total invoice amount for this purchase. Currency Code ISO 4217 currency code used in order invoice (for example: USD, GBP, INR). External Reference ID An ID that can be used to track this purchase externally. Action - Update Status of Referred Purchase Parameters Parameter Description Customer Email Email address of customer who made the referred purchase. For information on this endpoint, see: https://www.referralcandy.com/api#referral. Notify Referring Customer Whether to notify customer who referred customer specified above that the referral has been disregarded. Potential values: true or false. Defaults to true. Returned Purchase Whether the customer has returned his/her purchase. Potential values: true or false. If set to true, the referral will be disregarded and rewards will not be paid out. Action - Unsubscribe an Advocate Parameters Parameter Description Email Address Contact's email address. For more information on this endpoint, see: https://www.referralcandy.com/api#unsubscribed. Action - Resubscribe an Advocate Parameters Parameter Description Email Address Contact's email address. For more information on this endpoint, see: https://www.referralcandy.com/api#unsubscribed. ... View more

This article describes how to set up the Ambassador connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Record Campaign Referral Event ✓ ✓ Update Ambassador ✓ ✓ Add Ambassador Commission ✓ ✓ Remove Contact ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Username: For information on how to find your username, see: https ://docs. getambassador .com/docs/authentication API Key For information on how to find your API key, see:   https ://docs. getambassador .com/docs/authentication Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Record Campaign Referral Event Parameters Parameter Description Email Address Your customer's email address. For more information on this endpoint, see: https://docs.getambassador.com/v2.0.0/reference#eventrecord. Campaign UID Your campaign's ID. Required if product ID is not used. Product ID Your product ID, which is assigned to one of your campaigns. Can be used instead of Campaign UID. Required if Campaign UID is not used. Short Code Referrer's "mbsy" shortcode, required for initial commissions. Revenue Revenue amount of the event. Default value is 0. Transaction UID Unique transaction ID for the event. IP Address Customer's IP address. Customer UID Your customer's internal unique ID. First Name Your customer's first name. Last Name Your customer's last name. Custom Field 1 Custom field. Related to ambassador. Custom Field 2 Custom field. Related to ambassador. Custom Field 3 Custom field. Related to ambassador. Email New Ambassador Email login credentials to new ambassadors (1=yes, 0=no). Default value is 1. Deactivate New Ambassador New ambassadors created are deactivated (1=yes, 0=no). Default value is 0. Auto Create Customer If the customer is not an ambassador, create them (1=yes, 0=no). Default value is 0 if you signed up for Ambassador after Nov 5 2013, otherwise default value is 1. Add to Group ID Define which group(s) new ambassadors will be created in. Using this parameter will override default group settings. Group IDs should be separated by commas. If add_to_group_id = -1 , then ambassador will not be added to any group. Event Data 1 Custom field. Related to the event. Event Data 2 Custom field. Related to the event. Event Data 3 Custom field. Related to the event. Commission is Approved Commission status (1=approved, 0=pending). Entering a value will override the campaign's auto approve setting; otherwise, the campaign's setting will be used if not provided. Street Your customer's street. City Your customer's city. State Your customer's state. Postal Code Your customer's postal code. Country Your customer's country. Phone Your customer's phone number. Action - Update Ambassador Parameters Parameter Description UID Your ambassador's internal unique ID. Required if email is not provided. If both UID and email are provided, UID will take precedence. For more information on this endpoint, see: https://docs.getambassador.com/v2.0.0/reference#ambassadorupdate. Email Address Your ambassador's email address. Required if UID not provided. If both email and UID are provided, UID will take precedence. New Email Address New email address for the ambassador. New UID New UID for the ambassador. First Name New first name for the ambassador. Last Name New last name for the ambassador. Custom Field 1 New value for custom field 1. Custom Field 2 New value for custom field 2. Custom Field 3 New value for custom field 3. Deactivate Ambassador 1=deactivate ambassador. 0=activate ambassador. Default value is 0. Deactivation will change the ambassador's status to 'Banned'. Send Welcome Email (1=yes, 0=no). Street New street for the ambassador. City New city for the ambassador. State New state for the ambassador. Postal Code New postal code for the ambassador. Country New country for the ambassador. Phone New phone for the ambassador. Paypal Email New PayPal email address for the ambassador. Company New company name for the ambassador. Set Groups Define which group(s) existing ambassadors will be put in. Using this parameter will override default group settings and an ambassador's current groups. Group IDs should be separated by commas. Action - Add Ambassador Commission Parameters Parameter Description UID Your ambassador's internal unique ID. Required if email address is not used. If both are present, UID takes precedence. For information on this endpoint, see: https://docs.getambassador.com/v2.0.0/reference#commissionadd. Ambassador Email Your ambassador's email address. Required if UID not used. If both are present, UID takes precedence. Campaign UID Your campaign's ID. Commission Amount Amount of commission. Customer Email Your customer's email address. First Name Your customer's first name. Last Name Your customer's last name. Revenue Amount Amount of revenue. Transaction UID Unique transaction ID for commission. Referrer UID Your referrer's internal unique ID. Customer UID Your customer's internal unique ID. Commission is Approved 1=approved commission, 0=pending commission. Email New Ambassador Email login credentials to new ambassadors (1=yes, 0=no). Deactivate New Ambassador New ambassadors create are deactivated (1=yes, 0=no). Event Data 1 Custom field. Related to event/commission. Event Data 2 Custom field. Related to event/commission. Event Data 3 Custom field. Related to event/commission. Action - Remove Contact Parameters Parameter Description Email Address Email address of the contact to remove. For information on this endpoint, see: https://docs.getambassador.com/v2.0.0/reference#complianceremove. ... View more

This article describes how to set up the Friendbuy connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Email Opt Out ✓ ✓ Send Email ✓ ✓ Post a Purchase ✗ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Access Key For information on how to get your API Access Key, see: Developer Docs: Security. API Secret Key For information on how to get your API Secret Key, see:  Developer Docs: Security. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Email Opt Out Parameters Parameter Description Email Address Email address to add to opt-out list. Only single email addresses allowed. For more information on this endpoint, see: https://developers.friendbuy.com/#span-class-method-post-post-span-span-class-restofendpoint-opt_outs-emails-span. Action - Send Email Parameters Parameter Description Email Address Where to send the email. Only single email addresses allowed. For more information on this endpoint, see: https://developers.friendbuy.com/#span-class-method-post-post-span-span-class-restofendpoint-communication_emails-span. Email Template ID ID of communication email template to be used. Coupon Bank ID ID of coupon bank to be used. Action - Post a Purchase Parameters Parameter Description Order ID Unique order ID for the purchase. If this order ID has been previously used, the request will fail and no new purchase (and no new conversion) will be created. For more information on this endpoint, see: https://developers.friendbuy.com/#span-class-method-post-post-span-span-class-restofendpoint-purchases-span. Referral Code Refcode that referred the friend to make the purchase. Required unless Coupon Code is present. If both Referral Code and Coupon Code are provided, Referral Code will take precedence. Coupon Code Coupon code that brought the friend to the merchant to make the purchase. Required unless Referral Code is present. Order Amount Amount of the order. Order Email Email address associated with the order. New Customer Whether or not the purchase is made by a new (first-time) customer. Possible values: true or false. Used to check for reward eligibility, since Friendbuy allows merchants to state “must be a new customer” as one of the reward criteria. Customer ID The ID you assigned to your customer (not the same as the internal Friendbuy-assigned ID). Customer First Name   Customer Last Name   Customer Email Email address associated with the customer. Stripe Customer ID Stripe’s ID for the customer. Chargebee Customer ID Chargebee’s ID for the customer ... View more

This article describes how to set up the SparkPost connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add or Update a Suppression ✓ ✓ Send Email ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Endpoint To find your SparkPost API endpoint, please see the 'Endpoint' section at https://developers.sparkpost.com/api. Please include 'https://' at the beginning of your API endpoint. API Key For information on where to find your SparkPost API keys, visit: https://app.sparkpost.com/account/api-keys. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add or Update a Suppression Parameters Parameter Description Email Address Email address of the user. For more information on this endpoint, visit: https://developers.sparkpost.com/api/suppression-list/#suppression-list-put-create-or-update-a-suppression. Suppression Record Type Possible Values: transactional or non_transactional . Description Explanation for the suppression. Action - Send Email Parameters Parameter Description Recipient Email Address Valid recipient email address. Only single values allowed. For more information on this endpoint, visit: https://developers.sparkpost.com/api/transmissions/#transmissions-post-send-a-template. Template ID ID of the email template to use. Recipient Name Name attached to the recipient email address. Campaign ID Name of the campaign. Maximum length: 64 bytes. Description Description of the transmission. Maximum length: 1024 bytes. Substitution Data Key-value pairs that are provided to the Sparkpost Template Engine. For more information on the Sparkpost Template Engine/Language, see: https://developers.sparkpost.com/api/template-language/. Transmission Metadata Key-value pairs associated with a transmission (email send). Metadata is provided to the Sparkpost Template Engine. A maximum of 1000 bytes of merged metadata (Transmission Metadata + Recipient Metadata) is available with Recipient Metadata taking precedence over Transmission Metadata when there are conflicts. For more information on the Sparkpost Template Engine/Language, see: https://developers.sparkpost.com/api/template-language. Recipient Metadata Key-value pairs associated with a recipient. Metadata is provided to the Sparkpost Template Engine. A maximum of 1000 bytes of merged metadata (Transmission Metadata + Recipient Metadata) is available with Recipient Metadata taking precedence over Transmission Metadata when there are conflicts. For more information on the Sparkpost Template Engine/Language, see: https://developers.sparkpost.com/api/template-language. Return Path Email address to use for envelope FROM. The domain of the Return Path address must be a CNAME-verified sending domain. For non-enterprise accounts, the local part of the Return Path address will be overwritten by SparkPost. For Enterprise accounts, the Return Path may be any valid email address and the local part in the Return Path will not be overwritten by SparkPost. Header To Email address to display in the 'To' header (instead of Recipient Email Address). Use Draft Template Whether to use the draft version. If this is set to true and no draft exists, the email will fail. Default value is false. Potential values: true or false. Tags Single value or array of text labels associated with a recipient. Maximum number of tags: 10 per recipient, 100 system wide. Any tags over the limits are ignored. ... View more

Tableau is an advanced data visualization platform. This article describes how to connect Tableau to the Tealium DataAccess solution. In this article: Table of Contents Placeholder Prerequisites Basic knowledge of Tableau Be sure to install the appropriate drivers from the Tableau website at http://www.tableau.com/support/drivers dsfds. To install, click Amazon Redshift and follow the directions on the screen. Tealium has a partnership with Tableau but is not a reseller. Ensure that you obtain the proper Tableau licensing before attempting to use the product. If you need assistance, contact your Account Manager to initiate and facilitate support. Connecting to Redshift This section describes how to add a new data soure and connect to Amazon Redshift. Use the following steps to connect to Amazon Redshift: Add a new data source. Enter your Redshift Credentials. Ensure that you require Secure Sockets Layer (SSL). Select a schema. Select the schema that most closely resembles your account and profile. For example, if your account is tealium and your profile is dataaccess your schema will be tealium__dataaccess . Select one or more tables. Tables and views for your account are listed in the Tables section. Select the tables that you want to analyze in Tableau. At this point, you can optionally join multiple tables if you know which fields relate the tables together. During this process, you will have to tell Tableau which field in the “left” table is related to the field in the “right” table and the enter the type of join that you want to create between the two tables (left, right, inner, or full outer). For additional information, see: Tableau: Joining Tables To start using the data, create a new sheet or select an existing sheet. AudienceDB Example In the following example, the keys used to join two (2) tables together are as follows:   visits_view.“visit - visitor id”  =  visitors_view_normalized.“visitor - id” Preparing Data for Analysis When using a new data source, organize the fields prior to creating any reports, as described in the following suggestions: Dimensions and Measures By default, most (or all) fields are imported as “dimensions”, or fields that you want to slice your data by. If you intend to use a field as metric that you can summarize, convert these fields from “dimensions” to “measures”. This often includes fields such as Order Total, Total Units, etc. Custom Measures EventDB is event-level data; therefore you will often want to count how often an event (row or record) contains a field with a specific value. An example is a custom measure of “Unique Visitors”. This is accomplished by creating a new calculated field using calculation shown in the following example. In this instance, it will count the unique number of times that a specific visitor ID appeared in the data:   COUNTD([Event - Visitor Id]) Examples of Custom Calculations The following list provides examples of other custom calculations you may want to use: Total Events (Measure)   COUNTD([Event - Id]) Mac+Chrome Revenue (Measure) IF FIND([Event - User Agent],"Chrome") > 0 AND FIND([Event - User Agent],"Mac") > 0 THEN [Event - Udo - Order Subtotal] END Unique Orders COUNTD([Event - Udo - Order Id]) High Value Orders COUNTD(IF [Event - Udo - Order Subtotal] > 500 THEN [Event - Udo - Order Id] END) While there are several default fields in EventDB, most of the other fields are unique to each customer database and based on what is configured in Tealium IQ. You can create custom calculations using any combination of default or custom fields in EventDB. Troubleshooting Unable to connect to RedShift due to a password issue Check that your password does not contain any of the following disallowed characters: Plus sign ( + ) At symbol ( @ ) Right or left curly brackets (  {,  } ) Right parenthesis (  ) ) Semicolon ( ; ) An error message occurs when attempting to connect to any Tableau Server page The Tableau server gateway port (Default = 80) is likely blocked by something outside of the Tableau Server, such as a proxy or firewall. As a result, the response from Tableau server does not reach the user. If you receive this message, it is likely that one of the following has occurred: The connection was reset. The connection to the server was reset while the page was loading. The site is temporarily unavailable or too busy, try again in a few moments. If you cannot load any pages, check your computer's network connection. If your computer or network is protected by a firewall or proxy, ensure that your browser is permitted to access the web. To resolve this issue, work with your IT team to unlock the port used as the gateway port on the Tableau server. Resources Tableau Knowledge Base Contains detailed information about commonly asked questions and best practices. Connecting Tableau to an Amazon RedShift Data Source This article describes how to connect Tableau to an Amazon Redshift database and set up the data source. ... View more

This article describes how to set up the Intercom connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Create or Update User ✓ ✓ Add Tag Based on ID ✓ ✗ Add Tag Based on User ID ✓ ✗ Add Tag Based on Email ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Access Token: Access Tokens use the bearer authorization header when you make a request. For more information about creating an access token, see Authorization: Access Tokens. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create or Update User Parameters Parameter Description User ID A unique string identifier for the user. It is required on creation if an email is not supplied *Either User ID or Email must be supplied Reference the following API documentation for more info Email The user's email address. It is required on creation if a user_id is not supplied *Either User ID or Email must be supplied Phone Number The user's phone number ID The ID may be used for user updates Signed Up At The time the user signed up Name The user's full name Last Seen IP An IP address (e.g. "1.2.3.4") representing the last IP address the user visited from your application form. (Used for updating location data) Last Seen User Agent The user agent the user last visited your application with Last Request At A UNIX timestamp (in seconds) representing the date the user last visited your application Unsubscribed From Emails A Boolean value representing the users unsubscribed status Default value if not sent is false Update Last Request At A Boolean value, which if true, instructs Intercom to update the users' last_request_at value to the current API service time in UTC Default value if not sent is false New Session A Boolean value, which if true, instructs Intercom to register the request as a session Action - Add Tag Based on ID Parameters Parameter Description Name Name of the tag. For more information on this endpoint, visit: Tag or Untag Users Reference ID ID of the user. Untag To untag a company or user, each user or company object sent in the tagging request can be submitted with an untag field whose value is set to true. Setting the untagvalue to false is the same as requesting the object be tagged. Action - Add Tag Based on User ID Parameters Parameter Description Name Name of the tag. For more information on this endpoint, visit: Tag or Untag Users Reference User ID The User ID of the user Untag To untag a company or user, each user or company object sent in the tagging request can be submitted with an untag field whose value is set to true. Setting the untagvalue to false is the same as requesting the object be tagged. Action - Add Tag Based on Email Parameters Parameter Description Name The name of the tag. For more information on this endpoint, visit: Tag or Untag Users Reference Email Email of the user Untag To untag a company or user, each user or company object sent in the tagging request can be submitted with an untag field whose value is set to true. Setting the untagvalue to false is the same as requesting the object be tagged. ... View more

View the Release Notes summary to learn about updated product features, enhancements, and fixes. To view details about how to use a new feature, click the Learn More link next to the description. Tags New/Cool Stuff New marketplace tag: Fit Analytics New marketplace tag: Sidecar Updated Adobe Target tag to version 1.6.2. (Learn more) Updated the Urban Airship tag template with latest vendor code. Updated Yieldify tag to the latest version. Fixes Corrected issue with the Fullstory tag requiring an update of the event API call. Renamed Delacon SVG logo file to logo_delacon_calltracking.svg to correct 404   error on tealium.com/integrations. Updated Adform tag template base URL  to a1.adform.net. Updated Google Analytics (gtag.js) to add routing support. (Learn more) Connectors New/Cool Stuff New marketplace connector: dotmailer. Deprecated previous dotmailer connector and replaced with this quick connector. (Learn more) New marketplace connector: Intercom. Deprecated previous Intercom connector and replaced with this quick connector. (Learn more) New marketplace connector: Webhook OAuth2 2-Legged (Learn more) New marketplace connector: Webtrekk (Learn more) Added logic to Mixpanel connector to filter out empty values. (Learn more) Enabled Event Stream support for the following AudienceStream Connectors: Optimizely Dynamic Customer Profile (DCP), Centro DSP, DataXu, TheTradeDesk, SalesForce DMP, DoubleClick for Publishers (DFP), DoubleClick Bid Manager, and AppNexus. Enhanced the "Merge Visitor into List" action for the Responsys connector to support merge status rules. ( Learn more ) Renamed Blue Kai connector to Blue Kai Mobile. (Learn more) Fixes Deprecated Google AdWords Customer Match connector until batching support is fully implemented. Universal Data Hub New/Cool Stuff Updated Publish dialog to be asynchronous to allow users to close the window during the publishing process. Fixes Corrected issue causing unpredictable results and profile problems when deleting attributes with dependent rules. Stitched Visitor Count and Badges/Audiences to correct sorting issues with numbers more than 1000 in Visitor Profile Sampler. iQ Tag Management New/Cool Stuff Added the tag status checker to the Tags tab in the user interface for convenience and ease of use when evaluating the status of all your tags on a given screen. (Learn more) The tags view in the user interface now display a list of related extensions for a better overview of the tag. (Learn more) Updated the CSS for Consent Manager and Preferences with a more responsive design. (Learn more) Updated the user interface for the JavaScript Code extension. (Learn more) Installations Fixes Updated Tealium for iOS to protect volatile data from being accessed by multiple threads. Corrected Android device integrations issue by updating the Last Event on Pause to prevent registering a crash on startup. ... View more

This article describes how to set up the DoubleClick for Publishers (DFP) connector in your Customer Data Hub account. Before you use this connector you must request that Google add your account to their whitelist. This allows Tealium AudienceStream to create segments in your Google account. Learn more about how to request that Tealium be whitelisted for your Google products. In this article: Connector Actions Action Name AudienceStream EventStream Add Visitor to User-List or Segment ✓ ✓ Remove Visitor from User-List or Segment ✓ ✓ API Information This connector uses the following vendor API: API Name: Google Audience Partner API DmpUserListService API Version: v201809 API Endpoint: https://ddp.googleapis.com/ Documentation: Google Ad Manager API Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. When you add this connector you are prompted to accept the vendor's data platform policy. After adding the connector, configure the following settings: Client Customer ID Required Your (DoubleClick Customer) Identifier in the selected Product. Create a New Segment Use the following steps to create a new segment in AudienceStream: Click Create a New Segment from the top of the Actions selection drop-down screen. Enter the following fields: Segment Name Segment Member Lifespan Integration Code - Integration Code is an ID used by user list sellers to correlate IDs on their systems. If no ID is available, enter a random number between 1 and 1000. Segment Description. Click Create Segment. Upon success, a check mark displays next to the Create Segment button. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add Visitor to User-List or Segment User segments created outside of the whitelisted connector will not be available in the connector configuration. Only segments created by the connector after your account has been whitelisted can be used. Parameters Parameter Description Select the Target User-list/Segment Required User map identifier. Specifies the user that this operation applies to. This is the target User-list/Segment where the user will be added to. Google User ID Google User ID Provided by the ADX cookie-matching service. iOS Advertising ID iOS Advertising ID Android Advertising ID Android Advertising ID RIDA Roku ID AFAI Amazon Fire TV ID MSAI Xbox/Microsoft ID Data Source ID Optional An ID indicating the data source that contributed this membership. Required to be in the range of 1 to 1,000. Any ID greater than 1,000 results in a BAD_DATA_SOURCE_ID error. These IDs do not have reference or meaning for Google and are only used as labels for reporting purposes. Action - Remove Visitor from User-List or Segment User segments created outside of the whitelisted connector will not be available in the connector configuration. Only segments created by the connector after your account has been whitelisted can be used. Parameters Parameter Description Select the Target User-list/Segment Required, this is the target User-list/Segment where the user will be removed from. Google User ID Google User ID Provided by the ADX cookie-matching service. iOS Advertising ID iOS Advertising ID Android Advertising ID Android Advertising ID RIDA Roku ID AFAI Amazon Fire TV ID MSAI Xbox/Microsoft ID Data Source ID Optional An ID indicating the data source that contributed this membership. Required to be in the range of 1 to 1,000. Any ID greater than 1,000 results in a BAD_DATA_SOURCE_ID error. These IDs do not have reference or meaning for Google and are only used as labels for reporting purposes. ... View more

This article describes how to set up the DoubleClick for Ad Exchange connector in your Customer Data Hub account. In this article: Connector Actions Action Name AudienceStream EventStream Add Visitor to User-List or Segment ✓ ✓ Remove Visitor from User-List or Segment ✓ ✓ API Information This connector uses the following vendor API: API Name: Google Audience Partner API DmpUserListService API Version: v201809 API Endpoint: https://ddp.googleapis.com/ Documentation: Authorized Buyer (formerly DoubleClick Ad Exchange) API Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. When you add this connector you are prompted to accept the vendor's data platform policy. After adding the connector, configure the following settings: Client Customer ID (Required) Your (DoubleClick Customer) Identifier in the selected product. Select the Target Product (Required) The target product, either DoubleClick AdExhchange - Buyer or DoubleClick AdExchange - Publisher. Create a New Segment Use the following steps to create a new segment in AudienceStream: Click Create a New Segment from the top of the Actions selection drop-down screen. Enter the Segment Name, Segment Member Lifespan, Integration Code, and Segment Description. Click Create Segment. The Integration Code is an ID used by user list sellers to correlate IDs on their systems. If no ID is available, you can manually enter a random number between 1 and 1000. Confirmation displays in the form of a check mark next to the Create Segment button to verify that the segment has been created. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add Visitor to User-List or Segment Parameters Parameter Description Select the Target User-list/Segment Required User map identifier. Specifies the user that this operation applies to. This is the target User-list/Segment where the user will be added to. Google User ID Google User ID Provided by the ADX cookie-matching service. iOS Advertising ID iOS Advertising ID Android Advertising ID Android Advertising ID RIDA Roku ID AFAI Amazon Fire TV ID MSAI Xbox/Microsoft ID Data Source ID Optional An ID indicating the data source that contributed this membership. Required to be in the range of 1 to 1,000. Any ID greater than 1,000 results in a BAD_DATA_SOURCE_ID error. These IDs do not have reference or meaning for Google and are only used as labels for reporting purposes. Action - Remove Visitor from User-List or Segment Parameters Parameter Description Select the Target User-list/Segment Required, this is the target User-list/Segment where the user will be removed from. Google User ID Google User ID Provided by the ADX cookie-matching service. iOS Advertising ID iOS Advertising ID Android Advertising ID Android Advertising ID RIDA Roku ID AFAI Amazon Fire TV ID MSAI Xbox/Microsoft ID Data Source ID Optional An ID indicating the data source that contributed this membership. Required to be in the range of 1 to 1,000. Any ID greater than 1,000 results in a BAD_DATA_SOURCE_ID error. These IDs do not have reference or meaning for Google and are only used as labels for reporting purposes. ... View more

Using DataXu Audience Ingestion APIs are designed send audience data into the DataXu platform. This article describes how to set up the DataXu Audiences connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add User to Segment(s) ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add User to Segment(s) Parameters Parameter Description Endpoint URL Optional When provided it will override the default endpoint Default endpoint is http://s2s-v2.w55c.net/s2s-servlet Segment(s) List/Array/Set of segment ids to which the user should be added. These segment ids can be either DataXu’s segment identifier (i.e. pixel id or segment uid) or the data partner’s segment identifier. Only Customer Data Hub Array/List/Set types are supported for all attributes configured in this section. i.e. only pick such data type as the value. Alias Type Represents kind of alias (API key of "alias_type") DataXu accepts the following alias types: DX GOOGLE_AD_ID SHA1_GOOGLE_AD_ID MD5_GOOGLE_AD_ID IDFA SHA1_IDFA MD5_IDFA ANDROID_ID SHA1_ANDROID_ID MD5_ANDROID_ID Alias ID Represents the actual identifier for the user (API key of "alias_id") and the specified "Alias Type" Timestamp Represents the time of the user’s addition to the audience (API key of "timestamp") Optional and preferably in UTC. example: 2016-12-01T15:16:33Z    ... View more

The Tealium Xamarin integration provides a set of cross-platform interfaces and configuration classes that interface with the native Tealium iOS and Android SDKs to simplify Tealium tracking Xamarin developers. In this article: Table of Contents Placeholder Overview The Tealium Xamarin integration provides a set of cross-platform interfaces and configuration classes that interface with our native iOS and Android SDKs to make Tealium tracking more straightforward for Xamarin developers. DLLs and Lifecycle Modules Dynamic-Link Libraries (DLLs)  described in this article are available at: https://github.com/Tealium/tealium-xamarin. Available DLLs Several DLLs are available for the Xamarin integration: Tealium.Common.dll This DLL contains cross-platform code, interfaces, and common code to be used in all projects within your Xamarin application. Add this DLL as a reference in both shared project and platform-specific projects. Abstraction DLLs Abstraction DLLS are included to create an easy-to-use C# API wrapper for the native Tealium SDKs and should only be referenced in platform-specific projects. These libraries contain platform-specific, concrete class implementations for the interfaces and abstract classes provided by the Tealium common library. You can code all of your cross-platform logic against the common library. Tealium.Droid.dll –  for Android mobile platforms Tealium.iOS.dll  –  for Apple mobile platforms There are DLLs specific to each mobile platform which are referenced by the abstraction DLLs. The platform DLLs are binding libraries and therefore embed our the native SDKs - they provide auto-generated wrapper code that would allow you to interact with our native SDKs directly and as a result they can be used standalone if desired. Tealium.Platform.Droid.dll Tealium.Platform.iOS.dll Binding libraries can be used by themselves. The fact that they are automatically generated results in vastly different namespaces for each platform, which adds an extra complication to development efforts. It is advised to make use of the Common and platform-specific abstraction libraries  instead. Lifecycle Modules An optional lifecycle module is available by referencing the relevant DLL for the platform. These are binding libraries for the native equivalent SDKs: Tealium.Platform.Lifecycle.Droid.dll Tealium.Platform.Lifecycle.iOS.dll Android Shared Project Example The following example illustrates the Shared project and Android platform-specific project from a typical Xamarin based app: As shown in the example, the Shared Project references only the Tealium.Common.dll library, whereas the Android-specific project references all of the following: Tealium.Common.dll Tealium.Droid.dll Tealium.Platform.Droid.dll Tealium.Platform.Lifecycle.Droid.dll Basic Configuration The first step for initialization is to ensure that your projects reference the appropriate libraries as described in the Overview. Though not required, Tealium recommends using the TealiumInstanceManager classes provided as they provide out-of-the-box, thread-safe Tealium instance management. Android Example The following example applies to an Android project: using Tealium.Droid; //... ITealiumInstanceManager instanceManager = new TealiumInstanceManager(new TealiumInstanceFactoryDroid(<myAndroidApplication>)); //Optional Lifecycle Module enablement - ensure to reference Tealium.Platform.Lifecycle.Droid.dll TealiumLifecycleManager.SetLifecycleAutoTracking = TealiumDroid.Lifecycle.TealiumLifecycleControlDelegation.SetLifecycleAutoTracking; iOS Example The following example applies to an Apple project: using Tealium.iOS; //... ITealiumInstanceManager instanceManager = new TealiumInstanceManager(new TealiumInstanceFactoryIOS()); //Optional Lifecycle Module enablement - ensure to reference Tealium.Platform.Lifecycle.iOS.dll TealiumLifecycleManager.SetLifecycleAutoTracking = TealiumIOS.Lifecycle.TealiumLifecycleControlDelegation.SetLifecycleAutoTracking; Creating Instances Once the TealiumInstanceManager is created, you can begin creating Tealium instances as with the native SDKs. The TealiumInstanceManager is a multiton pattern that provides access to multiple named instances if you need to track data on more than a Tealium profile. Use the following steps to create a new instance: Create a TealiumConfig object to hold various required and optional configuration items, as shown in the following example: TealiumConfig tealConfig = new TealiumConfig("TEALIUM_INSTANCE",//Instance Name "tealiummobile",//Tealium Account Name "demo",//Tealium Profile Name "dev",//Tealium Envrionment true);//Optional Auto Lifecycle AutoTracking (default: true) When complete, you can then can use your TealiumInstanceManager to create a Tealium instance which can be used to track your events, as shown in the following example: ITealium tealium = instanceManager . CreateInstance (tealC onfig ); Advanced Configuration The TealiumConfig class has constructor options that allow you to specify optional parameters to enable or disable the more advanced aspects of the Tealium Mobile SDKs. These parameters are optional as not all customers require these features. Remote Commands An object containing RemoteCommand blocks if you need to work with the features provided by the TagBridge tag. Similarly, you can supply code for the delegated methods that you can use in the native versions of the SDKs as well, such as Remote Commands. While the majority of the events within mobile are either sent to our data collection servers to be actioned through connectors, or processed in the tag management web view to trigger vendor tags. Remote Commands provide additional flexibility in that events used for tag management can pass data back to your native code through the IRemoteCommand interface. The following sample code prints out the CommandId (set to TealiumConsts.REMOTE_COMMAND_ID ). Using this example, you will also have access to a full payload of data, as configured in the associated TagBridge Custom Command tag required to set this up: static List<IRemoteCommand> SetupRemoteCommands() { var command = new DelegateRemoteCommand(TealiumConsts.REMOTE_COMMAND_ID, "Test command " + TealiumConsts.REMOTE_COMMAND_ID) { HandleResponseDelegate = (DelegateRemoteCommand cmd, IRemoteCommandResponse resp) => { System.Diagnostics.Debug.WriteLine($"Handling command {cmd.CommandId}..."); } }; return new List<IRemoteCommand>() { command }; } Delegate Methods There are five delegated methods that allow you to inject code into the processing logic within the Tealium SDK: DelegateDispatchValidator Provides two delegate methods  where the Boolean return value determines whether or not an existing dispatch should be dropped or queued. This is useful if you have steps within your app where you know that the user may be offline or you specifically want to write your own batching logic for example. ShouldDropDispatchDelegate ShouldQueueDispatchDelegate DispatchSentDelegateEventListener Called whenever a dispatch has been sent. DispatchQueuedDelegateEventListener Called whenever a dispatch has been queued. WebViewReadyDelegateEventListener Called when the WebView is fully loaded and ready, if you are using the Tag Management module. SettingsPublishedDelegateEventListener Executed when there has been an updated set of publish settings retrieved. The following example illustrates the usage of the delegate method: static TealiumAdvancedConfig SetupAdvancedConfig() { DelegateDispatchValidator validator = new DelegateDispatchValidator() { ShouldDropDispatchDelegate = (ITealium arg1, IDispatch arg2) => { System.Diagnostics.Debug.WriteLine("Inside ShouldDropDispatchDelegate!"); return false; }, ShouldQueueDispatchDelegate = (ITealium arg1, IDispatch arg2, bool shouldQueue) => { System.Diagnostics.Debug.WriteLine("Inside ShouldQueueDispatchDelegate!"); return shouldQueue; } }; DispatchSentDelegateEventListener sendingListener = new DispatchSentDelegateEventListener() { DispatchSent = (tealium, dispatch) => { System.Diagnostics.Debug.WriteLine("Inside DispatchSent!"); dispatch.PutString("KeyAddedBySendListener", "Value added by sending listener."); } }; DispatchQueuedDelegateEventListener queuingListener = new DispatchQueuedDelegateEventListener() { DispatchQueued = (tealium, dispatch) => { System.Diagnostics.Debug.WriteLine("Inside DispatchQueued!"); dispatch.PutString("KeyAddedByQueuedListener", "Value added by queuing listener."); } }; WebViewReadyDelegateEventListener webViewListener = new WebViewReadyDelegateEventListener() { WebViewReady = (tealium, webView) => { System.Diagnostics.Debug.WriteLine("Inside WebViewReady!"); } }; SettingsPublishedDelegateEventListener settingsListener = new SettingsPublishedDelegateEventListener() { SettingsPublished = (tealium) => { System.Diagnostics.Debug.WriteLine("Inside SettingsPublished!"); } }; TealiumAdvancedConfig advConfig = new TealiumAdvancedConfig(validator, sendingListener, queuingListener, webViewListener, settingsListener); return advConfig; } Tracking To trigger specific events within your app, use the appropriate method for the type of event that you want to track, as shown in the following sections. Screen View Tracking The following example uses screen view tracking: // Get ITealium instance ITealium tealium = instanceManager . GetExistingInstance ( TealiumConsts . INSTANCE_ID ); // Track a Page View event with the title "View Name" but no extra event data. tealium . TrackView ( " View Name " ); // Track a Page View event with the title "View Name" along with the "page_type" event daata. tealium . TrackView ( " View Name " , new Dictionary < String , object >( 1 ){ { " page_type " , " product detail page " } }); // Track a Page View event with the title "View Name" along with a single piece of event data. // This an equivalent way to the track call directly above. tealium . TrackView ( " View Name " , " page_type " , " product detail page " ); Event Tracking The following example uses event tracking: // Get ITealium instance ITealium tealium = instanceManager.GetExistingInstance(TealiumConsts.INSTANCE_ID); // The TrackEvent method has the same overloads as TrackView, so only one additional example is provided. // Track an Event with three pieces of specific Event Data. tealium.TrackEvent("Event Name", new Dictionary<String, object>(3){ {"event_category", "Menu"}, {"event_action", "Button Click"}, {"event_label", "Logo"} }); Adding Event Data As with the native SDKs, there are two additional types of variables that you can set to be added to each of your events. Persistent Data Persistent data will be merged into your event-specific data dictionary on every event that you trigger, as well as persist between launches, as shown in the following example: //Get ITealium instance ITealium tealium = instanceManager.GetExistingInstance(TealiumConsts.INSTANCE_ID); tealium.AddPersistentDataSources(new Dictionary<string, object>(1) { //Data will be merged into every event. { "PersistentDataTest", "Example persistent value." } }); Volatile Data Volatile data will be merged into your event-specific data dictionary on every event, just like persistent data. The key difference is that once the application is closed, volatile data is lost and will not be present on the next launch. //Get ITealium instance ITealium tealium = instanceManager.GetExistingInstance(TealiumConsts.INSTANCE_ID); tealium . AddVolatileDataSources ( new Dictionary < string , object >( 1 ) { //Data will be merged into every event. { " VolatileDataTest " , " Example volatile value. " } }); Consent Management The Consent Management feature comes from the two native SDKs embedded into the DLLs named Tealium.Platform.*.dlls . The Tealium.Common.dll provides the following category and status enums to use: Tealium.ConsentManager.ConsentStatus Tealium.ConsentManager.ConsentCategory Enabling Consent Management To enable Consent Management, simply pass the optional parameter in the constructor of TealiumConfig or set it as a property, as shown in the following example: TealiumConfig tealC onfig = new TealiumConfig ( TealiumConsts . INSTANCE_ID , TealiumConsts . ACCOUNT_NAME , TealiumConsts . PROFILE_NAME , TealiumConsts . ENVIRONMENT , true , commands , advConfig , false ); //optional Consent Manager Enablement. //or subsequently enable it: tealConfig . IsConsentManagerEnabled = true ; //then initialise your Tealium Instance: var tealium = instanceManager . CreateInstance (tealC onfig ); Overriding Initial Consent Status As with the native SDKs for both Android and iOS, when Consent Management is enabled, new users are assumed to be in an Unknown state. Tracking requests are queued up until the consent status has been opted-in or out, at which point events will be sent or purged, respectively. You can override the initial status through properties on the TealiumConfig object, as shown in the following example: // enable Consent Manager: tealConfig . IsConsentManagerEnabled = true ; // Set Users to be Consented by default: tealConfig. InitialUserConsentStatus = ConsentManager . ConsentStatus . Consented ; // Or set Users to be Not Consented by default: tealConfig. InitialUserConsentStatus = ConsentManager . ConsentStatus . NotConsented ; // Opt users into All Categories tealConfig. InitialUserConsentCategories = ConsentManager . AllCategories ; // or none: tealConfig. InitialUserConsentCategories = ConsentManager . NoCategories ; // or partial opt-in, only to Analytics and Mobile categories. tealConfig. InitialUserConsentCategories = new ConsentCategory []{ ConsentManager . ConsentCategory . Analytics , ConsentManager . ConsentCategory . Mobile }; Updating the User Consent Selection The ConsentManager can be interacted with directly from the Tealium instance, through the ConsentManager property. If you need to update a user's consent selection, simply pass the relevant values. Only the enum values available in the ConsentManager.ConsentCategory and ConsentManager.ConsentStatus should be used, as shown in the following example: // if the user is in an Unknown state, then the following code would trigger any queued events would be sent after this: ITealium tealium = instanceManager . GetExistingInstance ( TealiumConsts . INSTANCE_ID ); tealium . ConsentManager . UserConsentStatus = ConsentManager . ConsentStatus . Consented ; // The above will inherently opt the user into all categories as none have been provide. // To grant consent and opt into a subset of categories you can use the overload: tealium . ConsentManager . UserConsentStatusWithCategories ( ConsentManager . ConsentStatus . Consented , new ConsentCategory []{ ConsentManager . ConsentCategory . Analytics }); Resetting Consent Preferences Additional options area available to reset the currently selected consent preferences. This will revert the user back to an Unknown status so that subsequent events will begin being queued again. To completely disable, disable it on the TealiumConfig object, as shown in the following example: ITealium tealium = instanceManager . GetExistingInstance ( TealiumConsts . INSTANCE_ID ); tealium . ConsentManager . ResetUserConsentPreferences (); Resources The following sections provide links to Tealium and Xamarin resources that contain detailed information about Tealium for iOS and Android Tealium Documentation The following resources provide links to Tealium documentation for Android and iOS. If you are building a mobile application in Xamarin, you will use bindings to our iOS and Android libraries. Tealium for iOS Tealium for Android Alternatively, if only using UDH services (AudienceStream, EventStream, DataAccess), the Tealium  C#  library may be used as the native code in a Xamarin project. Vendor Documentation The following resources provide links to Xamarin's extensive documentation for adding Tealium's Android and iOS libraries: Xamarin Binding a Java Library Xamarin - Binding an iOS Objective-C Library Walkthrough: Binding an iOS Objective-C Library ... View more

This article describes how to set up the The Trade Desk In-App Events connector in your Customer Data Hub account. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send In-App Event ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Advertiser ID (adv) Represents your Advertiser ID on The Trade Desk. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send In-App Event Parameters Parameter Description TTD Event Tracker ID ( upid ) TTD Event Tracker ID ( upid ) Mobile App Event ( ref ) This should be the same as the name of the event. Same as the value that you have configured on The Trade Desk configuration page for this specific event ( ref ) Mobile Client IP Address ( client_ip ) Mobile Client IP Address ( client_ip ) Mobile IDFA for iOS ( idfa ) IDFA is the iOS ID for Advertisers ( idfa ) Mobile GPS ADID for Android ( gps_adid ) ADID is the Google Play Advertiser ID ( gps_adid ) Mobile NAID for Windows ( win_naid ) Windows NAID is the Windows Phone Device ID ( win_naid ) Revenue Tracking Value ( v ) Revenue tracking parameters v and vf are only sent if the UI is enabled. ISO 4217 currency codes are used for vf field Floating point numbers are expected for the v field. Example: 0.99 , 3.99 Revenue Tracking Currency ( vf ) Revenue tracking parameters v and vf are only sent if the UI is enabled Note that ISO 4217 currency codes are used for vf field Floating point numbers are expected for the v field. Example: 0.99 , 3.99 Additional Query Data Provide any additional url query parameter data if needed   ... View more

This article describes how to set up the The Trade Desk (theTradeDesk) connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send First Party Advertiser Data ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Agency Secret Key Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send First Party Advertiser Data Parameters Parameter Description Data Center Region Required Select data center geographically closest to where user data comes from. Advertiser ID Required Advertiser ID Trade Desk ID (TDID) Trade Desk ID ( TDID ) Device Advertising ID (DAID) Device Advertising ID ( DAID ) Override TTL in Minutes Override time to live ( ttl ), in minutes Override Timestamp Override timestamp Data Name Required Data Name ... View more

This article describes how to set up the dotdigital connector in your Customer Data Hub account. Table of Contents Placeholder How it Works The dotdigital connector provides digital marketing professionals with SaaS technology solutions and tools, and offers an email marketing platform. Connector Actions Action Name AudienceStream EventStream Trigger Campaign ✓ ✓ Send Email Using a Triggered Campaign ✓ ✓ Send SMS ✓ ✓ Create or Update Contact ✓ ✗ Add Contact to Address Book ✓ ✗ Delete Contact from Address Book ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Username Username for your API user. To get started using the API, you must first create an API user. These API user credentials (username/password) are required to authenticate each operation/method call and to ensure that you are connected to the correct account. For setup information, see the following vendor documentation: Getting Started with the API API Password Password for your API user. Region ID Region ID to be included in every API endpoint. You can find your API endpoint under Settings > Access > API users. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Trigger Campaign Parameters Parameter Description Campaign ID The ID of the campaign, which needs to be included within the request body. Address Book ID The Address Book ID the campaign is to be sent to. You must specify either an Address Book ID or a Contact ID. Contact ID The Contact ID the campaign is to be sent to. You must specify either an Address Book ID or a Contact ID. Send Date The date and time at which you want the campaign to be sent. Action - Send Email Using a Triggered Campaign Parameters Parameter Description To Address The email address of the recipient. Campaign ID The ID of the triggered campaign. For more information on this endpoint, see the following vendor documentation: Send transactional email using a triggered campaign. Personalization Values Each personalization value is a key-value pair. Action - Send SMS Parameters Parameter Description Telephone Number The mobile number of the contact. Message The SMS message to be sent to your contact's mobile phone. Action - Create or Update Contact Parameters Parameter Description Email The email address of the contact. For more information on this endpoint, see the following vendor documentation: Create contact. Data Fields Each contact data field is a key-value pair. Opt-In Type The opt-in type of the contact. Email Type The email type of the contact. Contact Id The ID of the contact. This must be set to update a contact. Action - Add Contact to Address Book Parameters Parameter Description Address Book ID The ID of the Address Book. For more information on this endpoint, see the following vendor documentation: Add contact to address book. Email The email address of the contact. For more information on this endpoint, see the following vendor documentation: Create contact. Data Fields Each contact data field is a key/value pair. Opt-In Type The opt-in type of the contact. Email Type The email type of the contact. Action - Delete Contact from Address Book Parameters Parameter Description Address Book ID The ID of the Address Book. For more information on this endpoint, see the following vendor documentation: Delete contact from address book. Contact ID The ID of the contact to be deleted. ... View more

A Dynamic Customer Profile (DCP) is a single, actionable view of your customer built from a combination of first and third-party customer data. It enables you to deliver consistent, personalized web and mobile experiences for your most valuable customers, and measure the impact of those experiences. In this article: Table of Contents Placeholder This article describes how to set up the Optimizely Dynamic Customer Profiles connector in your Customer Data Hub account. Connector Actions Action Name AudienceStream EventStream Update Customer Profile ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Token: Visit http://app.optimizely.com/tokens to generate an API token, or http://developers.optimizely.com/classic/token for more information. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Update Customer Profile Parameters Parameter Description DCP Service ID For more information on where to find your DCP Service ID, visit: Create Audiences with Dynamic Customer Profiles. Datasource ID For more information on where to find your Datasource ID, visit: Create Audiences with Dynamic Customer Profiles. Customer ID in Datasource For more information on where to find your Customer ID, visit: Create Audiences with Dynamic Customer Profiles. Tealium recommends using the Optimizely end user ID found in the first party cookie. Customer Profile Attributes A Profile Attribute describes one aspect of a customer's profile within a data source. The specified attribute value overwrites any existing value specified earlier. If a key does not correspond to a registered attribute name, the write will fail, and if a value does not respect the attribute's datatype/format, the write will fail. ... View more

The most advanced analytics for mobile in the world. This article describes how to set up the Mixpanel connector in your Customer Data Hub account. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Track Event ✓ ✓ Update Profile - Set ✓ ✓ Update Profile - Add ✓ ✓ Update Profile - Append ✓ ✓ Update Profile - Union ✓ ✓ Update Profile - Unset ✓ ✓ Update Profile - Delete ✓ ✓ Update Profile - Track Revenue ✓ ✓ Create Alias ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Project Token: A project token is required to send profile and events data to Mixpanel. See: Where can I find my project token? Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Track Event Parameters Parameter Description User ID   IP Address   Override Event Time   Event Name (Required) Event Data Custom properties to add to your event Date type properties are converted to Mixpanel date format 'YYYY-MM-DDThh:mm:ss' Properties with empty values are skipped and not included Action - Update Profile - Set Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Created   Phone Number   Last Name   Email   First Name   Full Name   Do Not Overwrite Existing Property Values (Set Once)   Action - Update Profile - Add Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Add Data Specify properties to add a numerical amount to their existing value It is possible to decrement values by providing a negative amount Properties with empty values are skipped and not included Action - Update Profile - Append Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Append Data Specify properties to append a value to their existing list of values Appending to a property that doesn't exist produces a new list with one element Properties with empty values are skipped and not included Action - Update Profile - Union Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Union Data Specify properties to merge their values with the existing list on the user profile Properties must be of Array type in Data Layer Properties with empty values are skipped and not included Duplicate values are ignored Action - Update Profile - Unset Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Unset Data Specify properties to permanently remove them and their values from a user profile Supports Array type in Data Layer Action - Update Profile - Delete Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Action - Update Profile - Track Revenue Parameters Parameter Description Ignore Last Seen Update   User ID (Required) IP Address   Override Update Time   Transaction Amount (Required) Transaction Time (Required) Action - Create Alias Parameters Parameter Description Original User ID Previously set identifier for a user Typically a temporary generated ID before a better user ID becomes available (example: user's email after sign up) New Alias User ID New ID to map to original ID Typically an alias is set immediately after user signs up and all subsequent events & updates utilize the new alias ID For more info see: Using Mixpanel Alias ... View more