> For the complete documentation index, see [llms.txt](https://docs.thewalletcrew.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/setup.md).

# Setup

Configure The Wallet Crew connector, connect Bloomreach credentials, and install the Bloomreach WebHook preset activities.

Connect **Bloomreach Engagement** with **The Wallet Crew** to orchestrate wallet journeys. Bloomreach scenarios can trigger pass actions (create, update, notify). The Wallet Crew also sends events back to Bloomreach for segmentation and measurement.

## Prerequisites

Before starting, make sure you have:

* **Bloomreach permissions**
  * Access to **Project settings → Integrations**.
  * Access to API credentials under **Project settings → Access Management → API**.
* **The Wallet Crew permissions**
  * Access to the admin console to configure the Bloomreach connector.
  * Permission to create and manage API keys.
* **Environment and test data**
  * Target environment identified (staging vs production).
  * A test pass exists, with a known `passId`, to validate calls end-to-end.
  * Any required network allowlisting and security constraints are in place.

## The Wallet Crew configuration

{% stepper %}
{% step %}

#### Enable the connector

The Bloomreach connector must be enabled for the tenant. This is typically done by The Wallet Crew team.
{% endstep %}

{% step %}

#### Configure general settings

Open the Bloomreach connector settings in the admin console (**Data & integrations → Connectors → Marketing automation → Bloomreach**), **General** tab.

<p align="center"><a href="https://admin.thewalletcrew.io/tenant/~/integrations/bloomreach/settings" class="button secondary" data-icon="chevrons-right">Open General settings page</a></p>

<div data-with-frame="true"><figure><img src="https://3852727835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlP7d71aYydav6e0pRkxc%2Fuploads%2Fgit-blob-9e6cb9821aca9c06323a46cf6136099222c893b4%2Fdocumentation-bloomreach-bloomreach-wallet-integration-general-settings.png?alt=media" alt="The Wallet Crew Bloomreach connector: general settings screen"><figcaption><p>General settings define how The Wallet Crew authenticates to Bloomreach.</p></figcaption></figure></div>

Fill in:

* **Project token** (the Bloomreach project token)
* **API base URL**
* **API key ID**
* **API secret**

Bloomreach values are available under **Project settings → Access Management → API**.

{% hint style="info" %}
The Bloomreach project token determines the target environment. This makes it possible to keep staging and production separated.
{% endhint %}

<div data-with-frame="true"><figure><img src="https://3852727835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlP7d71aYydav6e0pRkxc%2Fuploads%2Fgit-blob-ba43eb739ae6a45f89ab8e0f9df6fb0bb6a6b9f0%2Fdocumentation-bloomreach-bloomreach-api-key.png?alt=media" alt="Bloomreach Engagement API credentials screen showing API keys and project token"><figcaption><p>Use a token and API key scoped to the correct Bloomreach environment.</p></figcaption></figure></div>
{% endstep %}

{% step %}

#### Advanced settings (extensibility)

Advanced settings expose script entry points for the connector. These scripts control contact resolution, event transformation, and field mapping.

<div data-with-frame="true"><figure><img src="https://3852727835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlP7d71aYydav6e0pRkxc%2Fuploads%2Fgit-blob-92301f7cc05c647c6273900f0f113b4156b64aae%2Fdocumentation-bloomreach-bloomreach-wallet-integration-advanced-settings.png?alt=media" alt="The Wallet Crew Bloomreach connector: advanced settings screen with script configuration blocks"><figcaption><p>Advanced settings are used for custom data models and governance.</p></figcaption></figure></div>

Details and script examples: [Components and scripts](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/extensibility.md).
{% endstep %}
{% endstepper %}

## Bloomreach configuration

{% stepper %}
{% step %}

#### Set up an HTTP authentication schema

Bloomreach calls The Wallet Crew APIs using an API key. This is configured once as an HTTP authentication schema in Bloomreach.

In Bloomreach:

1. Go to **Data & Assets → Integrations → + Add new integration**.

<div data-with-frame="true"><figure><img src="https://3852727835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlP7d71aYydav6e0pRkxc%2Fuploads%2Fgit-blob-053ad06a996dad2b5ade9013ce3451562116f01f%2Fbloomreach-integrations-add-http.png?alt=media" alt="Add new HTTP integration" width="375"><figcaption><p>Add a new HTTP integration in Bloomreach.</p></figcaption></figure></div>

2. Select **Http Authentication Schemas**.

<div data-with-frame="true"><figure><img src="https://3852727835-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlP7d71aYydav6e0pRkxc%2Fuploads%2Fgit-blob-f87507612ccf585f5d2fe940ed02484254bf6f96%2Fbloomreach-http-auth-integration-picker.png?alt=media" alt="Http Authentication schemes configuration" width="375"><figcaption><p>Select Http Authentication Schemas.</p></figcaption></figure></div>

3. Configure the schema with an API key created in The Wallet Crew.

The API key needs the `tenant.pass:write` permission. Create it in the admin console under **Settings → Access control → API keys & secrets**. Additional permissions can be required depending on the activity set.

<p align="center"><a href="https://admin.thewalletcrew.io/tenant/~/access/api-keys-and-secrets/api-keys" class="button secondary" data-icon="chevrons-right">Open API keys</a></p>

Bloomreach schema values:

<table data-header-hidden data-full-width="true"><thead><tr><th width="141.88885498046875"></th><th></th></tr></thead><tbody><tr><td>Endpoint</td><td><code>https://&#x3C;host>/api</code>: the production or staging host from <a href="https://docs.thewalletcrew.io/connectors/marketing-automation.md#environments-and-urls">Environments and URLs</a></td></tr><tr><td>Type</td><td>Custom headers</td></tr><tr><td>Key</td><td><code>X-API-KEY</code></td></tr><tr><td>Value</td><td>The API key created in The Wallet Crew</td></tr></tbody></table>
{% endstep %}

{% step %}

#### Install the WebHook preset activities

Bloomreach activities are installed as WebHook preset integrations. The install payload and endpoint of each activity are in [Bloomreach activities](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/bloomreach-activities.md), together with the icons to use.

A Bloomreach authentication schema is bound to one endpoint. Staging therefore needs its own authentication schema and its own set of activities.

{% hint style="danger" %}
Endpoints include `<<tenantId>>`. Replace it with the tenant identifier of The Wallet Crew.
{% endhint %}
{% endstep %}
{% endstepper %}

## Validation checklist

A minimal validation run usually covers:

* One test pass exists and its `passId` is available in Bloomreach.
* One Update pass activity refreshes visible content on the pass.
* One Notify activity delivers a message.
* One test install/uninstall produces Bloomreach events.

Event names and properties: [Events](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/events.md).

## Best practices

* **Staging first**: validate activities and events with a test Bloomreach project token.
* **Progressive rollout**: install only Notify first, then add Apply benefit.
* **Multi-team setup**: IT configures credentials and allowlists, marketing installs the scenario activities.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
