Search documentation...

K
ChangelogBook a demoSign up

Bloomreach

Bloomreach helps companies personalize customer experiences by targeting the right customers with the right experience at the right time.

Bloomreach is a premium destination and is only available on Business tier plans.

Supported syncing

Sync TypeDescriptionSupported Sync Modes
EventsSync data from any source to any eventsInsert
CustomersSync data from any source to the customer objectsUpsert

Getting started

To use the Bloomreach destination in Hightouch, you need to provide a Bloomreach API Key, API Secret, API URL, and Project Token. Follow these steps to retrieve your credentials:

  1. In Bloomreach, click the wheel icon in the top right corner. Select Project Settings from the dropdown.
  2. Click on Access management in the side navigation. Select API from the options.
  3. Your Project token and API Base URL are here. You can either use an existing API Key ID and API Secret, or you can click + Add key to create another one.

Syncing data

Events

When syncing events, Hightouch treats any records added to your source as new events and sends them to Bloomreach when your sync runs.

To ensure syncs send each event, your event model must use a truly unique primary key. See the events syncs documentation for more information.

You need to select the type of event and one or more hard and/or soft customer IDs to make the API call to Bloomreach. The most common customer IDs are registered.

Selecting columns to send as events to Bloomreach

Field mapping

One or more of the event properties, also known as attributes, are required. The event properties show up as custom mappings and attach custom data relevant to your event.

Mapping event properties in the Hightouch UI

Custom mappings are included as the properties parameter of the API request payload.

For more information about event properties, refer to Bloomreach's documentation.

Customers

You can also sync to the Customers object. This integration supports Upsert mode, meaning you can insert new customers and update existing ones in Bloomreach.

Record matching

You can match rows in your model with customers in Bloomreach on one or more of the following hard and/or soft customer IDs:

  • Cookie
  • Email
  • Registered

ID mappings are included as the customer_ids parameter of the API request payload.

Field mapping

You need to include at least customer property you wish to update. The customer properties show up as custom mappings and attach custom data relevant to your customer.

Mapping customer properties in the Hightouch UI

Custom mappings are included as the properties parameter of the API request payload.

For more information about customer properties, refer to Bloomreach's documentation.

Tips and troubleshooting

Common errors

To date, our customers haven't experienced any errors while using this destination. If you run into any issues, please don't hesitate to . We're here to help.

Live debugger

Hightouch provides complete visibility into the API calls made during each of your sync runs. We recommend reading our article on debugging tips and tricks to learn more.

Sync alerts

Hightouch can alert you of sync issues via Slack, PagerDuty, SMS, or email. For details, please visit our article on alerting.

Ready to get started?

Jump right in or a book a demo. Your first destination is always free.

Book a demoSign upBook a demo

Need help?

Our team is relentlessly focused on your success. Don't hesitate to reach out!

Feature requests?

We'd love to hear your suggestions for integrations and other features.

Last updated: Jan 17, 2023

On this page

Supported syncingGetting startedSyncing dataEventsCustomersTips and troubleshootingCommon errorsLive debuggerSync alerts

Was this page helpful?