Bloomreach Engagement
Bloomreach is a platform that drives engagement, conversions, and CRM revenue using customer and product data.
Aurora supports the Bloomreach Tracking API. This document describes how to enable tracking events and related options.
Prerequisites
- You must have a Bloomreach account
- You will need your Bloomreach Auth Token
- You will need your Bloomreach ** Tracking API Endpoint** URL
- This will look like:
https://CLIENT-api.bloomreach.co/track/v2/projects/PROJECT-ID
- This will look like:
Aurora supports the Bloomreach Tracking API via Private API Access.
For more information about Private API Access please see the Bloomreach documentation: https://documentation.bloomreach.com/engagement/reference/technical-information#private-api-access.
Configuration
Navigate to the the Aurora Back-end, under Store > Settings > Feeds > Bloomreach Engagement.
Enter your Test/Live Auth Token and Test/Live Tracking API Endpoint and select the Enable Bloomreach? checkbox.
Tick/untick Live Mode? as required.
Click Apply Settings to save.
The Bloomreach integration is now enabled. However, none of the specific tracking events are. It is necessary to enable each tracking event separately, as you see fit.
Tracking Events
Aurora uses the Bloomreach Tracking API to track events.
More information about this API can be found here: https://documentation.bloomreach.com/engagement/reference/add-event.
Wallet Creation
When placing orders in Aurora that include an Eagle Eye discount card, once the order has passed fraud approval, and all Eagle Eye API processing is complete, an API request will be sent to Bloomreach to track this event.
Notifications of this type must be enabled via checking the Track Wallet Creationconfiguration option in Store > Settings > Feeds > Bloomreach Engagement
The following information will be sent to Bloomreach:
| Key | Type | Description |
|---|---|---|
| event_type | string | Name of the event: "online_card_sign_up". |
| timestamp | integer | Timestamp of when the request was made |
| customer_ids | object | |
| customer_ids.email_id | string | The email address associated with the wallet |
| customer_ids.wallet_id | string | The wallet ID |
| properties | object | |
| properties.physical_card | bool | Always: true |
| properties.wallet_id | string | The wallet ID |
When Aurora attempts to send this event, additional fields will be stored on the order for auditing purposes.
The following order additional fields will be added:
| Name | Description |
|---|---|
bloomreach_event_online_card_sign_up_datetime |
The date and time the Tracking event API request was attempted; Formatted as DD/MM/YYYY HH:MM:SS |
bloomreach_event_online_card_sign_up_success |
Whether the request was successful; |
Errors
If an error occurs when attempting to send a tracking event, or if the Bloomreach API responds with an error, details will be logged in the Aurora Error Log. To see these logs navigate to the admin area and then to:
Tools > Logs > Error Log.
To show only Bloomreach errors, select Filter Results > Group > Bloomreach.
Debugging
To debug API requests, you can enable request logging.
Do so by checking the Enable API Logging? checkbox.
All subsequent requests to the Bloomreach API will be logged to the API Integration Log. To see these logs navigate to the admin area and then to:
Tools > Logs > API Integration Logs
Select your date range, then select Bloomreach from the Integration drop down and then click search.
Updated 3 days ago