Bloomreach

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:

Integrating with Bloomreach

To integrate an existing system with Bloomreach:

1. Navigate to Data map → View 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.

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.

Authentication setup

Fides supports two authentication methods for consent webhooks. OAuth2 client credentials (recommended), which handle token refresh automatically, and static Bearer tokes that requires manual token rotation every 90 days.

Option A: OAuth2 client credentials (recommended)

With OAuth2 client credentials, Bloomreach automatically obtains and refreshes short-lived access tokens from Fides. No manual token rotation is required.

1. Generate OAuth2 client credentials by calling the Fides API:

   POST /api/v1/plus/connection/{connection_key}/consent-webhook/oauth2-client

   The response contains client_id and client_secret. Save these values — the client_secret is only shown once.

2. On your Bloomreach admin dashboard navigate to Data & Assets > Integrations and click + Add new integration.

3. Search for OAuth 2.0 and click on + Add integration.

4. Configure the OAuth 2.0 integration:

   • Token endpoint URL: https://{your-fides-url}/api/v1/oauth/token
   • Client ID: Use the client_id from step 1
   • Client Secret: Use the client_secret from step 1
   • Client Authentication Method: Select Auth Header or Body parameters

5. If your Fides URL differs from the token endpoint domain, enable "Allow webhooks from domains other than the token's endpoint" and add your Fides base URL to the allowed domains list.

6. Click Save Integration.

Option B: Static Bearer token (deprecated)

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

3. Select custom headers. Endpoint: your_fides_url, Key: Authorization, Value: Bearer {your_consent_webhook_token}.

4. Click on Save Integration.

Scenario setup

Once you have configured authentication (either OAuth2 or static token), create a Bloomreach scenario to forward consent events:

5. Navigate to Campaigns > Scenario and click on + New Scenario. On the pop up window click Create New Scenario

6. From the selection tab on the right grab the On event item located on the triggers section and drop it on the canvas.

7. Click on the added On event item and select consent as the event trigger.

8. Click on Done.
9. From the selection tab on the right grab the Webhook item located on the actions section and drop it on the canvas.

10. Click on the newly added webhook item and navigate to Settings.
11. Activate the Authentication option and select your recently created authentication from step 4.
12. On the Other section click on the Consent Category dropdown and select General Consent.

13. 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 }}"
}

16. You may now click on Test Webhook to verify that the payload is being received by fides.
17. Click on Done.

18. 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.