Back

This article describes how to add and configure connectors for Tealium EventStream API Hub and Tealium AudienceStream CDP.

In this article:

How it Works

A connector is an integration that transmits data between Tealium and another vendor in real-time.  A connector offers actions that represent vendor-supported APIs. An action is triggered in real-time by an incoming event from a feed or a visitor joining or leaving an audience. An action sends data based on mappings that associate Tealium attributes to the expected vendor parameters.

Terminology

  • Connector
    A connector represents the connection to your vendor account. This is configured using credentials such as an account ID, username and password, or an API key.
  • Action
    An action is a vendor operation, such as triggering an email, building a custom audience, or managing leads. Actions vary depending on the vendor service. Multiple 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 an event feed.

Consent Categories

Each 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 server-side consent, see Consent Preferences Manager.

Add a Connector

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

  1. Navigate to EventStream > Event Connectors or to AudienceStream > Audience Connectors.
  2. Click + Add Connector.
  3. Browse or search for a connector, then click the connector to add.
    The connector summary, including links to vendor documentation and configuration instructions displays.
  4. Click Continue.
    The Select Source screen displays.

Select a Source

To create an action, first select the type of data you want to send and configure the vendor service.

Select a Source for EventStream

  1. Select a Data Source.
  2. Select an Event Feed and click Continue.
    About Connectors Select Data Source and Event Specification.png

Select a Source for AudienceStream

Connector actions that send audience data are controlled by triggers that determine when to fire the action.

Triggers can only be applied to an audiences and not to events.

  1. Select an Audience.
  2. Select a Trigger.
    • Joined Audience - Trigger the action if a visitor joined the audience during this visit. For example, when a Cart Abandoner or Frequent Shopper joins an audience.
    • Left Audience - Trigger the action if a visitor left the audience during this visit.
    • In Audience at start of visit - Trigger the action at the beginning of the visit if the visitor is already in the audience.
    • In Audience at end of visit -Trigger the action if the visitor is in the audience at the end of the visit.
  3. To limit how often this action triggers, toggle Frequency Cap to On, then select an Action Priority and an Action Cooldown Group.
    For more information, see Action Frequency Capping & Prioritization.

Configuration

In the Configuration step specify the credentials for your account with the vendor. This is usually an account ID, username and password, an API key, or other settings required by the vendor.

  1. In the Name field, enter a meaningful name for this instance of the selected connector.
  2. Under Authentication, provide your login credentials, token or password, Account ID, and any other information required for establishing a connection with the vendor service.
  3. Click Done.

Action Settings

Use the following steps 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. Select an Action Type.
  4. Complete the required fields for the action selected, using pre-populated drop-down lists where available.
    When  a value is selected or entered for required fields, COMPLETED is shown.

    ConnectorsCreateCustomAudience.png
  5. Expand each section to complete any optional fields as needed.
  6. If the connector supports visitor segmentation, click Create Custom Audience to create a custom audience.
  7. Click Finish.
  8. Save and Publish your profile.
    The actions you configured will now fire when the trigger conditions are met.

Map Attributes (Optional)

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

Use the following steps to map Tealium attributes to the parameter 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, 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. In the To field, 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 you have added and configured a connector, 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. Find the action you want to validate and view the log status.

Managing Connectors

This section describes how to turn a connector off or on, copy a connector and the associated configuration settings, and delete a connector.

Turn a Connector or Actions On or Off

Use the On/Off toggle to turn on or off a connector or action. If you turn off a connector, all associated actions for that connector are also turned off.

Toggle On Off Connector Workflow.png

Duplicate a Connector

Use the following steps to duplicate a connector and the actions associated with the connector:

  1. Navigate to the connector, expand the menu, and click Duplicate.
    ConnectorDuplicateOptions.png
    A new, identical connector, including the associated actions, is shown in the list of connectors. The connector name is appended with " - copy".
    ConnectorDuplicateCopy.png
  2. (Recommended) Expand the menu 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 actions and click Finish.
  6. Save and Publish your changes.

Delete a Connector

To delete a connector:

  1. Navigate to Connectors.
  2. If there are actions associated with the connector, they must be removed before the connector can be removed, as follows:
    1. Click on an action to expand it.
    2. Click the menu and then click Remove.
  3. If the connector is not shown in the list, select Show All Available Connectors.
    Connectors with no associated actions are not included in the list by default.
  4. Expand the connector menu, and click Remove.
    A confirmation message displays.
  5. Confirm that you want to delete the connector and click Remove.

Get a Connector ID

To get the connector ID:

  1. Navigate to Connectors.
  2. Expand the menu for the connector and click Get Connector ID.
    ConnectorMenu.png

Copy an Action ID

To copy the action ID:

  1. Navigate to Connectors.
  2. Select an action, then click Details.
  3. Click the copy icon for the Action ID.
    ActionIDDetails.png

Deprecated Connectors and Actions

Connectors and actions can be deprecated, which means they may be unsupported or removed in the future. Deprecation typically occurs when a connector or an action has been replaced with a newer version or a new connector or action that should be used instead.

There are two types of deprecation, as follows:

  • Functional Deprecation – The connector or action is deprecated, and may be removed in the future, but is still working.
  • Full Deprecation – The connector or action is deprecated and no longer works. Actions for a fully deprecated connector are not executed.

When a connector or an action is deprecated, an icon is shown next to the connector or action in the connector list. When you hover over the icon, a message is displayed that specifies whether the deprecated connector or action still works. 

DeprecatedConnector.png

Screen Navigation

Overview Screen

The connector overview screen summary displays the following metrics as columns:

  • Total
    Total actions triggered. Click the Information (i) icon to display the timeline for the total in this column.
  • Success
    Number of action successes.
  • Error
    Number of action errors.
  • Data Source (EventStream) or Audience (AudienceStream)
    Data source or audience associated with the connector.
  • Feed (EventStream) or Trigger (AudienceStream)
    Name of the feed or trigger for the action.

Expand the Add Action menu to quickly access the Edit, Duplicate, Get Connector ID, or Remove features.

ScreenOverviewAddActionOptions.png

Reporting Chart for Actions

The following sections describe how to view the reporting chart, view error details, and download error reports.

Connector Reporting Graph Overview.png

View the Chart

When you click on a connector action, the chart displays the number of times the action executed each day.  You can view the graph for a rolling day, week, or month. Successful actions are shown in gray and errors are shown in red. Click any part of the chart to view a summary of the data for that display.
Successful Connector Triggers.png

View Sampled Errors

Use the following steps to view sampled errors for a connector:

  1. Click an action for the connector you want to view.
  2. From the connector summary, select Rolling Day, Rolling Week, or Rolling Month.
  3. Below the graph, a list view of error messages is shown. Each entry in the list displays the error category, the number of sampled errors included in the report, a message with a description of the error, and the total number of occurrences of the error.
  4. To view the details for an error, click the right arrow next to the category to expand.
    The detailed view includes a sample of the affected code with a timestamp containing the day of the week, the date, and the time.

Download Sampled Errors

Use the following steps to download sampled errors for a connector:

  1. Click an action for the connector you want to view.
  2. From the connector summary, select Rolling Day, Rolling Week, or Rolling Month.
  3. Click Download Sampled Errors.
    A .csv file is saved to your default download location.
  4. Open the .csv file to examine the details or share the file with others for further collaboration.

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.

Public