How to set up event streams

👍

Data hub rollout

Data hub provides new unified API integration methods for sending data to multiple Bloomreach products. Access is being rolled out in phases. For new implementations, we recommend using Data hub where available. Existing product-specific integrations remain fully supported for Engagement, Discovery, and Clarity.

Process overview

  1. Log in to Data hub > Event streams
  2. Create "New"
  3. Copy the integration credentials
  4. Connect the destinations
  5. (Optional but recommended) Configure DNS for your Custom Tracking Domain
      1. This is similar to the process in Engagement, read more here: Custom Tracking Domain
      2. The NS type of CTD setup is recommended when integrating tracking with Data hub
  6. Deploy snippet and tracking on your website
  7. Validate the successful function of the tracking
    1. Locally in your browser using the browser extension (compatible with Chromium-based browsers such as Chrome and Edge)
    2. In the Engagement app, check if the data is incoming
      1. Navigate to Data & Assets > Customers
      2. Data & Assets > Data manager (Customer properties, Events)
    3. In the Discovery app, check if the data is incoming
      1. Navigate to Setup > Event diagnostics (formerly called Events management)
      2. Setup > Event alerts (formerly known as Pixel Monitor)

To learn more about debugging tracking issues in Discovery, read more here: Pixel Errors on Pixel Monitor.

To learn more about NS DNS setup in Custom Domain Management, read more here: Custom Domain Management.

📘

Note

Discovery Pixel Integration is incompatible with Bloomreach Web SDK.

Migration process for existing users

  1. Align with your Bloomreach CSM or consultant to confirm that migration is the right step for you.
  2. Get your account enabled (you will need to activate the Data hub module).
  3. Enable permissions for your users to access Data hub
    1. To manage Event streams, you will need to grant your users the Event streams admin role.
  4. Follow the instructions in the SDK migration from existing Engagement tracking guide and work with your technical consultant to modify your tracking setup.

📘

Note

The current system does not provide a solution for seamless migration of existing users to the new unified tracking.

While migration from Engagement tracking should be straightforward, migration from Discovery tracking involves a rework of pixel integration since the new SDK won't read from Discovery's br_data.

For developer users

For Engagement developers adopting Data hub:

  • During development, an Event stream links to a DEV Engagement project
  • For production, you will need Event streams to link to a PROD Engagement project
    • You can create a new Event stream with a new stream ID, or alternatively, you can reconnect your Event stream to a PROD Engagement project destination

For Discovery developers adopting Data hub:

  • An Event stream links to a Discovery account
  • During development, use track debug events and tracking must have metadata test_data=true, and optionally have debug=true

📘

Note

If you have both Engagement and Discovery, you may want to disable some Discovery event types from Engagement to keep it clean of less relevant data.

In Data Manager, add suggest_click and search_submit and forbid the event type to be received.

It's not possible to have multiple Stream IDs on one website. If one source needs to track data to both destinations, it must be one Event stream connected to Engagement and Discovery destinations.

All events from an Event stream are forwarded to Engagement, and events that comply with Discovery requirements are forwarded to Discovery. There is no customizable filter. It is possible to block events from Engagement in Data manager.