Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bloomreach activities

Use Bloomreach scenarios to create, update, and notify Apple Wallet and Google Wallet passes managed in The Wallet Crew.

Bloomreach activities are scenario steps that call The Wallet Crew APIs. They turn a CRM decision (who/when/what) into a wallet action (create, update, notify).

Activity catalog

These activities are typically created in Bloomreach as Webhook preset integrations. Each activity calls one The Wallet Crew endpoint.

HTTP authentication setup is covered in Setup. Each activity below gives its install payload, written in the Bloomreach WebHook preset parameter syntax. Install only the activities you need: it keeps scenario building simple and reduces configuration drift. One Bloomreach integration is typically created per activity.

The endpoint URLs below use <host> (see Environments and URLs) and <<tenantId>>: replace <<tenantId>> with the tenant identifier. API details: API reference.

Activity icons are available as a file:

Open

Notify

Bloomreach activity icon: Notify
Icon to use when installing the Notify activity in Bloomreach.

Notify sends a wallet message to a pass. On Apple Wallet, the message is delivered as a lock‑screen notification. On Google Wallet, the message appears on the pass.

Install payload (Notify)

Endpoint URL:

Example payload (single language):

Example payload (localized):

correlationId is optional, but when it is sent it must be 10 to 100 characters long, otherwise the call is refused (400). The same rule applies to the Apply benefit payload. Remove the correlationId line from the payload if the scenario does not set it.

Apply benefit

Bloomreach activity icon: Apply benefit
Icon to use when installing the Apply benefit activity in Bloomreach.

Apply benefit attaches a benefit to a pass. That benefit can be a coupon, an access right, or a perk.

Benefits are first-class objects in The Wallet Crew. They can be displayed on the pass and tracked over time.

Apply benefit fits benefits with a lifecycle (availability, expiry, redemption). For the full concept, see Benefit templates.

Install payload (Apply benefit)

Endpoint URL:

Activities installed with the former endpoint POST .../passes/<passId>/privileges still work, but that endpoint is deprecated. Install new activities with the /benefits endpoint and the payload below.

Payload example (unlocalized benefit):

The payload also accepts activationDate, deactivationDate and deletionDate (date and time). Without them, the benefit is active at once, never expires and is never removed from the pass. A pass carries at most 20 benefits until their deletion date, so set a deletionDate for time-limited offers.

origin.processId makes the call idempotent: a second call with the same processId for the same pass updates the benefit instead of adding another. The response returns the benefitId of the written benefit.

Update pass

Bloomreach activity icon: Update pass
Icon to use when installing the Update pass activity in Bloomreach.

Update pass refreshes a pass so it reflects the latest data. This is the primary activity used to keep the pass accurate.

Typical updates include points, tier, balance, expiry, seat, venue, and instructions.

Install payload (Update pass)

Endpoint URL:

Minimum payload (options only):

Example payload to update additionalData. The key bloomreach_message is an illustrative name: choose your own key, and make a field of the pass template read it with {{ additionalData.bloomreach_message }}.

Example payload to change the pass template (passType):

Add benefit movement (advanced, on request)

This activity updates a counter on an existing benefit. This is mainly used for punch cards, “progress to reward”, or multi-entry packs.

The activity calls POST https://<host>/api/<<tenantId>>/passes/benefits/<benefitId>/movements. The body carries oldValue (the balance as last read; the movement is refused with 409 if the balance changed since), value (a signed whole number: positive credits, negative redeems) and optional remarks. The benefitId is returned by Apply benefit. The Bloomreach install payload is provided on request.

Create pass (advanced, on request)

Create pass generates a new pass and returns its identifier. This is useful when Bloomreach is the orchestration layer and a pass does not exist yet.

The activity calls POST https://<host>/api/<<tenantId>>/passes?passType=<pass template> with the pass identifiers and additionalData in the body. The Bloomreach install payload is provided on request.

FAQ

What’s the difference between Update pass and Notify?

Update pass changes what is displayed on the pass. Notify is a delivery mechanism meant to bring attention.

In most time-sensitive flows, Update pass runs first, then Notify.

When is Apply benefit better than Update pass?

Apply benefit fits benefits with a lifecycle. Examples include vouchers, access rights, and offers that expire.

Update pass fits state values. Examples include points, tier, and balance.

Where does the pass identifier (passId) come from in Bloomreach?

The pass identifier can be stored as a Bloomreach customer property. It can also be captured from The Wallet Crew events sent to Bloomreach.

What happens if the pass is not installed, and how do I test in staging?

See the guards in Recipes and the staging test run in Recipes.

Last updated