Skip to content

Bloomreach

This Integration requires Fides Cloud or Fides Enterprise. For more information, talk to our solutions team. (opens in a new tab)

Bloomreach (opens in a new tab) is a digital experience platform that helps companies deliver personalized customer experiences through email marketing, data management, and e-commerce optimization.

Prerequisites

In order to integrate with Bloomreach, you'll need to collect the following information:

Your Bloomreach API should be of Private access type`,
NameDescription
DomainYour Bloomreach API URL (default: api.exponea.com). You can find this in your Bloomreach account under Project Settings > Access Management > API
API Key*Your Bloomreach API key. You can find this in your Bloomreach account under Project Settings > Access Management > API
API Secret*Your Bloomreach API secret. You can find this in your Bloomreach account under Project Settings > Access Management > API
Project Token*Your Bloomreach project token. You can find this in your Bloomreach account under Project Settings > Access Management > API
Bloomreach Customer ID NameThe name of the hard_id/soft_id for customers in Bloomreach (default: registered)
Bloomreach Identity Key*The name of the identity (email or external_id) used in the privacy request that maps to the Bloomreach customer ID
Your Bloomreach API credentials will need to have the following scopes: Events > Consent(get/set), GDPR > Anonymize customer, Export customer ,

Integrating with Bloomreach

To integrate an existing system with Bloomreach:

  1. Navigate to Data mapView Systems and choose the system that you want to connect.
  2. Click on the Integrations tab.
  3. Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
  4. Complete the required fields for the integration and click Save.

You may confirm your connection is working using the Test connection button, if desired.

To learn more, please see our guide for Managing Integrations.

Bidirectional Consent

Bloomreach also supports bidirectional consent. To configure this, click on the Bidirectional consent accordion under the Bloomreach configuration form. This section allows you to map Privacy Notices in Fides to Consent Categories in Bloomreach. In the example below, setting Marketing for the Marketing information consent category will automatically subscribe and unsubscribe the user from that category if they opt-in or out of the Marketing privacy notice in Fides.

Bidirectional consent mappings

Consent changes should only be made through events. Changes made through the Bloomreach admin dashboard wont trigger a consent event and will cause fides to be out of sync.

Consent webhooks

Bloomreach supports webhooks that can be configured to automatically forward consent preference changes to Fides. When users update their consent preferences directly in Bloomreach, these changes can be automatically synchronized with Fides.

To set up consent webhooks we will need to setup an Authentication integration and a Bloomreach scenario:

  1. On your Bloomreach admin dashboard navigate to Data & Assets > Integrations and click + Add new integration
  2. Search for HTTP Authentication schemas and click on + Add integration
Bidirectional consent mappings
  1. Select custom headers. Endpoint: your_fides_url, Key: Authorization, Value: Bearer {your_consent_webhook_token}.
Bidirectional consent mappings
  1. Click on Save Integration.
  2. Navigate to Campaigns > Scenario and click on + New Scenario. On the pop up window click Create New Scenario
Bidirectional consent mappings
  1. From the selection tab on the right grab the On event item located on the triggers section and drop it on the canvas.
Bidirectional consent mappings
  1. Click on the added On event item and select consent as the event trigger.
Bidirectional consent mappings Bidirectional consent mappings
  1. Click on Done.
  2. From the selection tab on the right grab the Webhook item located on the actions section and drop it on the canvas.
Bidirectional consent mappings
  1. Click on the newly added webhook item and navigate to Settings.
  2. Activate the Authentication option and select your recently created authentication from step 4.
  3. On the Other section click on the Consent Category dropdown and select General Consent.
Bidirectional consent mappings
  1. Navigate back to the Editor tab of the webhook.
  • You'll notice that the base url from the webhook is now the url that was setup on the authentication integration. In this example the fides_url is an ngrok endpoint.
  • The endpoint method should be set to POST.
  • The dropdown to the right of the Endpoint header should be set to Do not process response.
  • On the empty textbox to the right of our base url set the endpoint to /api/v1/plus/connection/{{integration_identifier}}/consent-webhook
  • The payload must contain the following parameters. (Note that the customer_id can be either a soft_id or a hard_id in this example we set it to the hard_id registered)
{
 "customer_id": "{{ customer_ids.registered }}",
 "email": "{{ customer.email }}",
 "category": "{{ event.category }}",
 "action": "{{ event.action }}"
}
Bidirectional consent mappings

The webhook endpoint expects a specific payload format. Make sure your Bloomreach webhook configuration sends the customer ID, email, category, and action fields as required.

  1. You may now click on Test Webhook to verify that the payload is being received by fides.
  2. Click on Done.
Bidirectional consent mappings
  1. Click on Save and then Start your scenario.

By configuring this scenario. Any consent event that happen inside of Bloomreach will be automatically forwarded and stored within Fides.

Technical detail

Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.

Bloomreach Endpoints

In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.

Privacy functionEndpointDescription
Access RequestsExport Customer (opens in a new tab)Returns information about a customer and their data
Update or Delete RequestsAnonymize Customer (opens in a new tab)Used to anonymize/delete a customer's data
Consent Access RequestsGet Consent Categories (opens in a new tab)Used to retrieve all available consent categories
Consent Access RequestsGet Customer Attributes (opens in a new tab)Used to access a customer's current consent preferences
Consent Update RequestsTrack Consent Events (opens in a new tab)Used to update a customer's consent preferences