> 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/recipes.md).

# Recipes

Practical scenario patterns to leverage Bloomreach Engagement with Apple Wallet and Google Wallet passes managed in The Wallet Crew.

This page collects practical recipes to leverage the integration between **Bloomreach Engagement** and **The Wallet Crew**.

The Bloomreach integrator (IT team or implementation partner) typically decides which activities to include and how to map data (see [Components and scripts](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/extensibility.md)). Most teams validate one recipe end-to-end in staging first. Recipes are then combined into multi-step scenarios.

## Send a wallet push notification (Notify activity)

{% hint style="info" %}
**Example:**

When an order is delivered, a notification confirms that shipment is under way.
{% endhint %}

If the message references updated pass content, run **Update pass** first, then **Notify**.

{% stepper %}
{% step %}

#### Define the trigger and the pass target

Start by selecting the scenario entry condition. Most setups rely on an order event, a segment entry, or a time-based rule, depending on when the pass update should happen.

Then confirm the scenario context includes a stable pass identifier. This keeps targeting consistent across updates and devices. In most Bloomreach implementations, this identifier is stored as a customer property such as `passId`.
{% endstep %}

{% step %}

#### Add the Notify activity

In Bloomreach, add the **Notify** activity from The Wallet Crew activity catalog. Set the notification content, then personalize it with scenario attributes (for example customer name or order number).
{% endstep %}

{% step %}

#### Guard against non-installed passes

Wallet messages require at least one active installation. Add a guard so Notify runs only when installation is confirmed.

Common guard patterns:

* Trigger Notify only after `wallet_installed`.
* Add a branch that checks installation flags stored in Bloomreach.

If no active installation exists, use a fallback channel (email/SMS) to distribute an “Add to Wallet” link.
{% endstep %}

{% step %}

#### Validate delivery on real devices

Validation should cover iOS and Android. It should also cover both logging and on-device behavior.

Check both:

* Bloomreach activity logs.
* On-device behavior (notification visibility and message rendering).
  {% endstep %}
  {% endstepper %}

Related reference: [Bloomreach activities](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/bloomreach-activities.md).

## Grant a benefit and reflect it on the pass (Apply benefit activity)

Apply benefit attaches a benefit to a pass. A benefit can be a coupon, an access right, or a perk with an expiry and redemption lifecycle.

{% hint style="info" %}
**Example:**

A “VIP Weekend” benefit is granted to a segment. The pass displays the perk and can switch to a “VIP” styling while the benefit is active.
{% endhint %}

Configure the pass template to display benefits and, when relevant, change styling based on active benefits. Optionally follow with **Notify** to announce the benefit.

{% stepper %}
{% step %}

#### Create the benefit model in The Wallet Crew

Start by defining the benefit template and its lifecycle: see [Benefit templates](https://docs.thewalletcrew.io/guides-animation/engage-and-animate/benefit-templates.md). Then confirm the pass template can display benefits, either as a list or as dedicated fields.
{% endstep %}

{% step %}

#### Create the Bloomreach scenario

Select a trigger that represents eligibility. Typical options include segment entry, tier change, or a purchase milestone.
{% endstep %}

{% step %}

#### Apply the benefit

Add **Apply benefit**, then define both the content and the lifecycle rules.

* title and description
* validity and expiry (when relevant)
* priority (when multiple benefits can overlap)

`processId` identifies the campaign. A second **Apply benefit** execution with the same `processId` on the same pass updates the existing benefit instead of creating a new one. Use a new `processId` for each campaign that must add a separate benefit.

{% hint style="warning" %}
To update or remove a benefit outside this activity, use its `benefitId`. The activity response returns it, but Bloomreach does not persist it by default: your scenario must store it if you plan to update or remove the benefit later.
{% endhint %}

Use one **Apply benefit** activity per pass and campaign. Set a `deletionDate` in the payload systematically so expired campaign benefits are cleaned up automatically.
{% endstep %}

{% step %}

#### Refresh and announce (optional)

If the pass template renders benefit data from the pass payload, add **Update pass** next. If the benefit needs attention, follow with **Notify**.
{% endstep %}

{% step %}

#### Validate in staging

Validation should cover creation, rendering, and lifecycle behavior.

* The benefit exists in The Wallet Crew.
* The pass reflects it (fields and visuals).
* The redemption lifecycle behaves as expected.
  {% endstep %}
  {% endstepper %}

Related reference: [Bloomreach activities](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/bloomreach-activities.md).

## Branch scenarios based on pass lifecycle (The Wallet Crew → Bloomreach events)

The Wallet Crew forwards wallet events to Bloomreach. These events make wallet measurable and triggerable as a CRM touchpoint.

{% hint style="info" %}
**Example:**

After pass creation, a scenario waits for `wallet_installed`. If install does not happen within a time window, a reminder email is triggered instead.
{% endhint %}

**Common scenario patterns**

* **Welcome only after install**: start an onboarding series only after `wallet_installed`.
* **Suppress wallet notifications**: do not run Notify when no active installation exists.
* **Churn signals**: trigger a reactivation flow after `wallet_uninstalled`.
* **Post-visit triggers**: trigger a follow-up after `wallet_scanned` (when Scan API is connected).

{% stepper %}
{% step %}

#### Confirm event forwarding

`wallet_created`, `wallet_installed`, `wallet_uninstalled`, `wallet_scanned`, and `wallet_linkOpened` must be visible in Bloomreach. This depends on connector configuration.

Validation steps are in [Setup](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/setup.md).
{% endstep %}

{% step %}

#### Start a scenario on a wallet event

Create a scenario triggered by a wallet event. Use `wallet_installed` for install-confirmed flows. Use `wallet_uninstalled` for suppression and win-back flows.
{% endstep %}

{% step %}

#### Add deduplication and time windows

Treat events as “at least once” and plan for duplicates.

Common safeguards:

* Store a `firstWalletInstalledAt` attribute.
* Use time windows (example: ignore repeated installs within 24h).
  {% endstep %}

{% step %}

#### Use the event properties for segmentation

Use `device`, `registrationSource_medium`, and `registrationSource_tags` to segment adoption and measure channel performance.

Keep governance in mind when passing identifiers through events.
{% endstep %}
{% endstepper %}

Related reference: [Events](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/events.md).

## Create or update a Bloomreach contact from The Wallet Crew enrolment form (CustomerFlowElement)

Component: see [Components and scripts](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/extensibility.md#customerflowelement).

{% hint style="info" %}
**Example:**

After a pass is installed, an enrolment form collects consent and profile data. The submission creates or updates the Bloomreach contact, then a Bloomreach onboarding scenario starts.
{% endhint %}

{% stepper %}
{% step %}

#### Decide the contact resolution strategy

Start by choosing which Bloomreach identifier is used for contact matching. Email is common because it is widely available in CRM data models. When a program has a stable member identifier, that identifier is often a better match key because it avoids issues with email changes.
{% endstep %}

{% step %}

#### Configure the enrolment form flow

Add **CustomerFlowElement** to the enrolment flow, then map form fields to Bloomreach contact properties. When consent is required by governance, make sure consent fields are collected and mapped as well.
{% endstep %}

{% step %}

#### Test a real submission

Run a real submission with a staging pass. Then confirm the contact is created or updated in Bloomreach, and that the identifiers used for matching remain consistent across subsequent submissions.
{% endstep %}

{% step %}

#### Start downstream scenarios

Trigger downstream scenarios after the contact upsert. A common pattern starts only after `wallet_installed`, then uses the form submission as the profile completion step.
{% endstep %}
{% endstepper %}

Related reference: [Components and scripts](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/extensibility.md).

## Display Bloomreach data on the pass (PassDataProvider + Update pass)

Component: see [Components and scripts](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/extensibility.md#passdataprovider).

{% hint style="info" %}
**Example:**

When a tier attribute changes in Bloomreach, a scenario runs **Update pass** so the pass immediately displays the new tier.
{% endhint %}

**Tutorial (Bloomreach as a pass data source)**

{% stepper %}
{% step %}

#### Identify the fields owned by Bloomreach

Start with stable profile fields owned by Bloomreach, such as tier label, points, preferred store, or personalization attributes. Keep transactional values in their system of record when accuracy or audit constraints apply.
{% endstep %}

{% step %}

#### Configure PassDataProvider

Enable PassDataProvider for the tenant, then confirm which Bloomreach properties are fetched. Naming conventions and mapping rules should be validated early to avoid field drift across environments.
{% endstep %}

{% step %}

#### Render the attributes in the pass template

Reference the PassDataProvider-exposed values in the template fields. Then validate the rendered values on a staging pass, including empty values and edge cases.
{% endstep %}

{% step %}

#### Trigger refreshes from Bloomreach

Create a scenario triggered by profile changes and add **Update pass**. When the change is time-sensitive, follow with **Notify** so it is visible without opening the pass.
{% endstep %}
{% endstepper %}

Related reference: [Components and scripts](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/extensibility.md).

## Combining recipes into multi-step campaigns

These recipes are designed as building blocks. In practice, scenarios often chain pass creation, pass refresh, benefit attachment, and messaging.

Common chains:

* Update pass → Notify
* `wallet_installed` → onboarding series
* Enrolment form submission → contact upsert → tier-based benefits

## FAQ

<details>

<summary><strong>How to test Notify without disturbing real users?</strong></summary>

Most teams isolate staging at both levels. A staging Bloomreach project token is used with a staging environment of The Wallet Crew, and a separate authentication schema and activity set (see [Bloomreach activities](https://docs.thewalletcrew.io/connectors/marketing-automation/bloomreach/bloomreach-activities.md)).

Tests are run with a small set of test passes installed on internal devices.

</details>


---

# 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/recipes.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.
