Back

This article describes how to add and configure connectors for the Tealium EventStream API Hub and AudienceStream Customer Data Platform (CDP).

In this article:

Table of Contents Placeholder

How it Works

A connector is an integration between Tealium and another vendor used to transmit data. Tealium users spend a large portion of their time working with connectors. The Customer Data Hub (CDH) interface offers feature-rich tools to add and configure connectors that  make your day-to-day experience faster, more logical, and dynamic.

Here's how it works:

  • Each connector has actions that represent vendor-supported APIs and are fueled by an event feed or an audience.
  • Data gathered from the event feed or audience is passed to an action.
  • Each action is based on data mappings that map connector data from your data attributes to the data format expected by the vendor.

Terminology

  • Action
    An Action is a vendor operation, like triggering an email, building a custom audience, or managing leads. Actions vary depending on the vendor service. Many actions can be associated with a single connector.
  • Frequency Cap
    A connector action performs in real-time, but some actions are designed to have a wait period before they are triggered. The frequency cap allows you to set a downtime period for actions so that they do not trigger immediately. Learn more about Frequency Capping and Prioritization
  • Source
    Source indicates the origin of the data being acted upon. A source can be an audience or a event feed.

EventStream Consent Categories

Each EventStream connector in the marketplace has one or more consent categories assigned for each available action. To view the consent category for a specific connector, click the Information icon next to the connector action.

EventStream Connector Consent Categories.png

AudienceStream is categorized in the CDP consent category and DataAccess is categorized in the Big Data consent category. For additional information about consent preferences, see Consent Preferences Manager.

Add a Connector

Use the following steps to add an EventStream or AudienceStream connector:

  1. In the left sidebar, go to EventStream > Event Connectors.
    For visitor data connectors, go to AudienceStream > Audience Connectors.
  2. In the left sidebar, browse for your vendor by Category or use the Spotlight search to find a specific connector.
  3. Click the tile for the connector you want to add.
    The connector summary, including links to vendor documentation and configuration instructions displays.
  4. Click Continue.
    The configuration screen for the connector displays.

Configure Settings

Before creating actions, you must first select the type of data you want to send and configure the vendor service.

  1. From the Data Source drop-down list, select the type of data to send.
    About Connectors Select Data Source.png
  2. From the Event Feed drop-down list, select an event specification and click Continue.
    About Connectors Select Data Source and Event Specification.png
  3. Click Add Connector.
  4. Enter a meaningful title for this instance of the selected connector and ensure that the radio button for this connector is checked.
  5. Click Continue.
  6. Under Authenitication, provide your login credentials, token or password, Account ID, and any other information required for establishing a connection with the vendor service.
  7. Click Done.

Action Settings

To add actions for this connector:

  1. Click Continue to add a connector action.
    The Add Action dialog displays.
  2. In the Action Name field, type a unique name for this action.
    This list varies, depending on the connector.
  3. In the Action Type field, select an available action from the drop-down list.
  4. Complete the required fields for the action selected, using pre-populated drop-down lists where available.
    When done, required fields for an item display "COMPLETED" on the right.
    About Connectors Add Action and Click Finish.gif
  5. Expand each section to complete any optional fields as desired.
  6. Click Finish.
  7. Save and Publish your profile.
    The actions you configured will now fire when the trigger conditions are met. This data populates, in real-time, as each action fires.

Map Attributes (Optional)

A connector action sends data according to the mapping configured. Some connectors offer a the ability to map the vendor attribute to Tealium attribute names. This section describes how to map these attributes when this choice is available.

Use the following steps to map Tealium attribute names to the parameter names expected by the vendor:

  1. Scroll to the bottom of the connector Actions list and click Custom Attributes to expand.
  2. Click + Add Mapping .
  3. In the Map field, use the drop-down list to select an attribute.
    This list is populated based on the Source you select. For example, choosing an audience displays all visit and visitor-scoped attributes but does not display event attributes.
  4. Click the To drop-down list and select a vendor parameter to map the attribute data to.
    If the To option is preselected, you are required to send data to that endpoint. You can optionally enter a custom name if the vendor supports custom parameters.
  5. Click Back to modify, or click Finish.
  6. Save and Publish your profile.

Test your Connector

After your connector is up and running, you need to test it. The easiest way to test your connector is by using the Trace Tool, as follows:

  1. Start a new trace.
  2. Examine the real-time log.
  3. Check for the action you want to validate by clicking the Actions Triggered entry to expand.
  4. Look for the action you want to validate and view the log status.

Copy (Duplicate) a Connector and Associated Actions

Use the following steps to make a copy (duplicate) of a connector and the actions associated with the connector:

  1. Navigate to the connector, expand the menu in the far right of the summary, and click Duplicate.
    Connectors V2 Duplicate Connector.png
    A new, identical connector, including the associated actions, now displays in the summary, appended with the word "copy".
    Connectors V2 - Duplicate Connector - copy.png
  2. (Recommended) Expand the menu to the far right again and click Edit.
  3. Rename the connector and click Done.
  4. (Optional) To add or edit actions associated with the new connector, click + Add Action.
  5. Follow the normal steps to add the desired actions and click Finish.
  6. Save and Publish your changes.

Delete (Remove) a Connector

Use the following steps to delete or remove a connector:

  1. Navigate to the connector, expand the menu in the far right of the summary, and click Remove.
    A confirmation message displays.
    • If there are actions associated with the connector, a list of those actions displays and must first be removed before proceeding.
    • Click Cancel and return to the connector configuration screen.
    • Remove the actions associated with the connector.
    • Repeat Step 1 to remove the connector.
  2. If you are sure you want to delete the connector, click Remove again.

Roll Back to a Previous Version

Use the following steps to revert back to a previous version of a connector instance:

  1. In the left sidebar, go to Server-Side Versions.
  2. Use the calendar drop-down lists to provide a date range for versions from which to select.
  3. If you modify the date from the default setting, click Update Date Range.
  4. Click to select a previous version of a connector.
    Connectors V2 Roll Back Version.jpg
  5. Save and publish your profile.
  6. Reload the page.
    Your connector is now reverted back to its previous state.

Additional Configuration Options

This section describes additional configuration options that can be used with some connectors.

The WHEN Condition

Connector actions that send audience data are controlled by WHEN conditions related to the behavior of the audience. The WHEN condition determines when to fire the action.

WHEN conditions can only be applied to audiences and not event feeds.

Select one of the following conditions:

  • Joined Audience
    Trigger this action when a visitor joins the audience. For example, when a Cart Abandoner or Frequent Shopper joins an audience.
  • In Audience at Start of Visit
    Trigger this action at the beginning of the visit if the visitor is already in the audience.
  • In Audience at End of Visit
    Trigger this action if the visitor is in the audience by the end of the visit.
  • Left Audience
    Trigger this action when a visitor leaves the audience.

Create Visitor Segments

If the connector supports visitor segmentation, such as Facebook Audiences or Google Adwords, these settings are configured in the Create tab. Enter the required information in the setup screens, click Continue > Finish and then Save and Publish your changes.

FAQ

Restricted Data

Connectors do not honor restricted data. This means that attributes marked as Restricted Data are always included, whether you are sending them through mappings or as part of the visitor profile. This cannot be changed. Learn more about Restricted Data.

IP Whitelists

If a connector you use has strict rules about which systems it accepts requests from, you can whitelist the IP addresses of the Customer Data Hub. The IP addresses that make connector requests can be found in the IP Addresses for Customer Data Hub.