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). The legacy version of this connector 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:

  • Account ID
    • The Optimizely account to which the events should be attributed.
  • Access 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
Visitor ID
  • Required
  • A unique identifier for the visitor.
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.
Project ID
  • Optional.
  • The Project ID only needs to be passed if you are using the Recommendations product.
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).
Enrich Decisions
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.
Timestamp
  • Required
  • Timestamp at which the event was generated, formatted in milliseconds since Unix epoch.
  • If unmapped, connector fire time is used.
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.
Key
  • Key
Quantity
  • Quantity
Revenue
  • Revenue
Type
  • The type of event.
  • For example, to indicate a decision_point, type should be campaign_activated.
Value
  • A scalar value associated with an event.
  • This should be some non-revenue number.
Event Tags
  • Optional.
  • Additional event properties.
  • Key-value attributes related to tags.
  • If used, type and value must be included as two of the keys.
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 an Experiment in order to accurately calculate campaign reach.
Campaign Holdback
  • Values are true or false.
  • If true, the chosen experience was held back at the campaign level.
  • Required for Personalization, omit otherwise.
Type
  • Required
  • Can be "custom"
Value
  • Required
Entity ID
  • Required for custom attribute type.

Additional Information