Bloomreach

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

Bloomreach is a customer data platform (CDP) offering a range of features such as content management, personalization, and marketing automation. Integrating Antavo with Bloomreach can allow businesses to create personalized marketing campaigns and improve their overall customer experience.

Antavo supports customer and event data synchronization between the two systems - this is a one-way data synchronization only, from Antavo to Bloomreach. This document shows how to configure a connection and data synchronization between the two platforms using Antavo’s Bloomreach module. Typical use cases will also be discussed in brief.

Find the configuration page of the Bloomreach module by searching for it from the Modules menu.

Configuring the Antavo – Bloomreach connection

The module configuration requires the API URL, the API Key, API Secret and a Project token for establishing and maintaining the connection.

Obtaining the connection data from the Bloomreach platform

The information for establishing the connection can be found in Bloomreach’s platform’s Project settings.

  • Click on the wheel icon in the upper right corner.

  • Select the Project settings option from the dropdown menu.

  • In the left-hand menu bar, go to Access management, then to the ‘API’ submenu.

  • Find the Project Token and the API Base URL at the top of the page.

  • The API Secret and API key requires the creation of a new API group.

    • Locate the API groups section on the page.

    • Click the dropdown and choose the New group option.

    • Pick ‘Private access’ as the access type.

    • Give the Group name.

    • Click ‘Create group’.

  • The API secret will appear in the subsequent popup.

  • Finally, the API Key becomes visible under the ‘Group keys’ section of the page.

Make sure to add the Get and Set permission after creating the new API group for Customer Properties and Events. These are required for synchronization.

Connecting Bloomreach in the Backoffice

Go back to the Bloomreach module’s page in Antavo’s Backoffice and fill in all four fields with the previously obtained information.
Click ‘Connect’.

Synchronizing the fields

The Sync Fields tab on the left-hand menu bar enables you to configure the field synchronization between the two systems

Hard ID configuration

The Hard ID is mandatory to set by choosing which Antavo field should be sent as a Hard ID. By default, the identifier for this field is 'registered,' and the value is the email address. This ID is case-sensitive and not deletable or editable after being set.

Custom fields

The Custom fields section lists the data that needs to be sent to Bloomreach. The Loyalty fields is a dropdown menu where Antavo data can be selected and the Remote fields section enables any desired field name convention so these fields will be automatically created in Bloomreach.

Settings

Event synchronization

This field allows you to add Antavo events using picklists to be synced with Bloomreach: Antavo sends the event to Bloomreach with the same ID (the event action’s name).

For example:

  • Checkout item event gets synched in Bloomreach as checkout_item

  • Checkout event gets synched in Bloomreach as checkout

  • Point Add event gets synched in Bloomreach as point_add

Basic information

The ‘Deferred sync’ checkbox offers the solution to send customer field update calls asynchronously.

If the checkbox is ticked, the Bloomreach request is executed later, instead of being triggered immediately when an action/event is generated in Antavo.

Deferred sync enables shorter API response times: if an event occurs within Antavo, there is no need to wait for the response from Bloomreach, resulting in a faster API response.

The Sync data and Sync multiple fields workflow nodes consider the newsletter provider extension’s deferred sync option automatically.

Use Cases

Fields and events can be synced using Antavo’s workflow solution. The use cases below present some common scenarios that can be performed with Antavo’s Bloomreach integration.

Welcome to the loyalty program!

This use case sends a welcome newsletter from Bloomreach when someone joins the loyalty program.

Go to the workflow management through the Workflows icon on the left sidebar, or type it in the search field of Modules .

  • Click ‘Create new general workflow’. Read more about the concepts of campaigns and workflows here.

  • Fill in the required fields to create the workflow. See the instructions here.

  • Drag and drop the Event trigger node to the empty canvas from the right sidebar.

    • Define the type of event on which the workflow should run – double-clicking on the node and the Opt-in event can be selected from the dropdown menu.

    • This way, this workflow will be activated every time someone enrolls in the loyalty program

    • Click 'Update'.

  • The Event trigger is connected to a Sync Bloomreach Event node.

    • This enables the selection of the Bloomreach event should be called and the payload, the information you would like to send to Bloomreach.

 

This example shows how to send the date of the opt-in and the points that have been added for enrolling.

Birthday reward

A reward can also be gifted to your loyalty members as a present on their birthday. This requires the creation of a suitable coupon-based reward. Read more about rewards here.

Go to the workflow management through the Workflows icon on the left sidebar, or type it in the search field of Modules .

  • Click ‘Create new general workflow’. Read more about the concepts of campaigns and workflows here.

  • Fill in the required fields to create the workflow. See the instructions here.

  • Drag and drop the On a date trigger to the canvas.

    • The trigger will run a rule to run once every day at a specific time. You can set it by choosing the Daily option in the On a date trigger and setting the desired time.

    • Click 'Update'.

  • Drag and drop the Customer attribute filter to the canvas. This filter can be used to check which customer has a birthday on that day.

    • The attribute for filtering is: birth_date,

    • the operator is: in date,

    • and the value should be: this day.

  • Subsequently, the Reward claim action node is used to select the previously created Birthday reward.

    • This is a gift so the Give this reward for free picker should be set to ‘Yes’.

  • The Sync Bloomreach Event can also be used to create an event name and sync this information.

    • It may be useful to add the coupon code to the payload so it can be used in further communications.

Reward claim

Data can also be sent to Bloomreach when a reward is claimed. This use case will use a Campaign, for demonstration purposes, but the same principles apply to a General Workflow. Read more about the concepts of campaigns and workflows here.

Go to the workflow management through the Workflows icon on the left sidebar, or type it in the search field of Modules .

  • Click ‘Create new campaign’.

  • Fill in the required fields to create the campaign. See the instructions here.

  • Drag and drop the Event trigger node to the empty canvas from the right sidebar.

    • Define the Reward – Claiming a reward as the event type.

    • Click 'Update'.

  • The Event trigger is connected to a Sync Bloomreach Event node.

    • This enables the selection of the Bloomreach event, e.g., loyalty_reward_claim, and the payload can contain additional reward information:

      • reward name

      • reward description

      • received coupon code

      • received coupon value

      • received coupon expiration date

Tier upgrade

In Antavo, one or more tier structures can be created and assigned to loyalty members based on their loyalty performance. It is a fairly common use case to synchronize the tier-up event to an NLP event as this is a great marketing opportunity to contact customers.
There are four point-based tiers in this use case:

  • Bronze – Everyone who opts-in

  • Silver – 10-50 points

  • Gold – 50-100 points

  • Platinum – 100+ points

All users are automatically assigned to Bronze after opt-in hence filtering and sending tier-up events are only needed for Silver, Gold and Platinum upgrades.

Go to the workflow management through the Workflows icon on the left sidebar, or type it in the search field of Modules .

  • Click ‘Create new general workflow’. Read more about the concepts of campaigns and workflows here.

  • Fill in the required fields to create the workflow. See the instructions here.

  • Drag and drop the Event trigger node to the empty canvas from the right sidebar.

    • Define the type of event on which the workflow should run – by double-clicking on the node, the Tier-up event can be selected from the dropdown menu appearing.

    • Click 'Update'.

  • The tier upgrade event trigger occurs for every upgrade event, so filtering is necessary to connect the correct NLP event to the upgrade. This filter can be performed by Event attribute filter with the Tier attribute; the operator should be equal with, and the correct value selected from the dropdown menu.

  • The Event trigger is connected to the Sync Bloomreach Event node.

    • The payload can include a new tier name (according to the filter in the Event attribute).

This example shows how to configure the synchronization of information related to the customer’s last purchase (number of loyalty points rewarded for the purchase and the number of loyalty points spent to reduce the basket value of the purchase) to predefined Bloomreach customer fields.

  • Navigate to Workflows through the icon on the left sidebar

  • Click ‘Create new general workflow’
    Read more about the concepts of campaigns and workflows here.

  • Fill in the required fields to create the campaign or workflow
    See the instructions here.

  • Drag and drop the Event trigger node to the empty canvas from the right sidebar

    • Select Checkout or Checkout accept (if you use the Checkout accept module) from the dropdown menu

    • Click 'Update'

  • Drag and drop the Sync multiple fields node and connect it to the Event trigger

    • Click the ‘Add’ button

      • Enter the name of the Bloomreach field (eg. last_purchase_earned_points)

      • Enter the {event.points} value
        This variable will provide the number of points rewarded for the checkout that triggered the current workflow in Antavo.

    • Click the ‘Add’ button

      • Enter the name of the Bloomreach field (eg. number_of_purchases)

      • Enter the {customer.purchase_count} value
        This variable will provide the customer’s total number of purchases registered in Antavo.

  • Click ‘Update’

  • Save your workflow by clicking the blue disk button

  • Click ‘Set active’ in the upper right-hand corner of the page

© Copyright 2022 Antavo Ltd.