> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Bloomreach Data Reference
> Reference for all Mention Me data sent to Bloomreach, including contact profile attributes, custom events, and ECR data import.
## Overview
The Mention Me integration with Bloomreach allows you to receive referral and advocacy-related events into your Bloomreach platform in real time.
### What the integration enables
* Send contact data and opt-ins from Mention Me referred customers to Bloomreach in real time
* Use referral data to trigger coupon email reminders
* Enhance marketing performance by segmenting and targeting high-value customers using referral and advocacy data
During setup, Mention Me automatically creates the necessary Customer Attributes and Custom Events in Bloomreach. No manual configuration is required.
Event and attribute data is pushed based on customer ID (typically email address). Mention Me sends profile and event data for any prospect or customer who triggers a Mention Me event, regardless of their opt-in status in Bloomreach.
### How contact matching works
* If a customer **already exists** in Bloomreach:
* Append Mention Me attributes to their profile
* Add Mention Me events to their profile
* If a customer **does not exist** in Bloomreach:
* Create their contact profile using email as the ID
* Append Mention Me attributes to the profile
* Add relevant Mention Me events
* Add a consent event only if explicitly captured during a Mention Me journey
## Contact Data
### How contacts are created
* Mention Me first checks if the customer already exists using email as the identifier.
* If the contact **does not** exist, a **new contact** will be created.
* If the contact **does** exist, Mention Me will update them with Mention Me-specific attributes only.
* Mention Me will only set the *email* field if no value is already present in Bloomreach.
### Customer consent
Mention Me can capture newsletter opt-in consent directly and send it to Bloomreach, eliminating the need to export CSVs.
When a customer consents through the referee journey or the post-purchase newsletter overlay, an opt-in tracking event is automatically sent to Bloomreach.
The opt-in is captured using Bloomreach's [Consent Tracking Event](https://documentation.bloomreach.com/engagement/docs/tracking-consent) under the consent category chosen during [integration setup](/knowledge/esp-crm/bloomreach/setup).
Consent metadata includes when and where it was captured:
* `mention_me_referee` = Referee journey opt-in
* `mention_me_newsletter` = Post-purchase newsletter overlay
A customer may have opted in via other sources. Mention Me is not the source of truth for all consent data.
### Customer profile attributes
The following custom attributes are created or updated on the customer profile in Bloomreach:
| Bloomreach Customer Field | Description | Example |
| ---------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| registered | Unique ID (usually email) | [jason.jones@mention-me.com](mailto:jason.jones@mention-me.com) |
| email | Email address (set only if no value exists) | [jason.jones@mention-me.com](mailto:jason.jones@mention-me.com) |
| mention\_me\_share\_link | Referrer's personal share URL to send to friends | [https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly](https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly) |
| mention\_me\_dashboard\_link | Referrer's dashboard showing referred friends | [https://demo.mention-me.com/d/2674816/9c34b0c2](https://demo.mention-me.com/d/2674816/9c34b0c2) |
| mention\_me\_share\_source | Channel used for share | OPEN-LINK |
| mention\_me\_referrals | Total successful referrals (includes historical) | 5 |
| mention\_me\_total\_shares | Total shares across all channels (includes historical) | 10 |
| mention\_me\_email\_shares | Email shares count | 2 |
| mention\_me\_facebook\_shares | Facebook shares count | 2 |
| mention\_me\_facebook\_messenger\_shares | Messenger shares count | 2 |
| mention\_me\_name\_sharing\_shares | Name sharing count | 1 |
| mention\_me\_whatsapp\_shares | WhatsApp shares count | 3 |
| mention\_me\_nps\_score | NPS score at post-purchase | 8 |
| mention\_me\_propensity\_to\_refer | Score from Smart Experiment (High or Low) | High |
| mention\_me\_ecr\_activity | ECR activity segment: Active, Dormant, Lapsed | Active |
| mention\_me\_ecr\_status | ECR value status: High, Medium, Low | High |
| mention\_me\_network\_id | Unique Network ID from Mention Me | N-5051-153480685 |
| mention\_me\_first\_share\_date | Date of customer's first referral share | 2024-06-03T16:19:08.000Z |
| mention\_me\_first\_referral\_date | Date of customer's first successful referral | 2024-06-03T16:19:08.000Z |
| mention\_me\_last\_share\_date | Date when last share was made | 2024-06-03T16:19:08.000Z |
| mention\_me\_last\_referral\_date | Date when last successful referral occurred | 2024-06-03T16:19:08.000Z |
| mention\_me\_ecr\_12m\_predicted | Predicted ECR status 12 months from now: High, Medium, Low, Lapsed | High |
| mention\_me\_referrer\_engaged | True if referrer accepted terms and engaged with the offer | Yes |
## Events
The Mention Me integration uses Bloomreach's custom events functionality to enable trigger-based workflows for email campaigns, segmentation, and automation. These events are automatically created in Bloomreach during setup and are associated with customer profiles via their email (registered ID).
Custom events are how scenario segmentations in Bloomreach can be linked to external triggers. They can be used to add contacts to a scenario, trigger email campaigns, or create dynamic segments.
### Summary of events sent to Bloomreach
| Mention Me Event Name | Bloomreach Event Name | When It Triggers |
| ----------------------------------------------------- | ----------------------------- | ------------------------------------------------------------------ |
| Registered as a Referee from Mention Me | registered\_as\_referee | When a customer has registered as a referee |
| Registered as a Referrer from Mention Me | registered\_as\_referrer | When a customer has registered as a referrer |
| Received a Referee Reward from Mention Me | received\_referee\_reward | When a customer obtained a reward as a referrer's friend |
| Received a Referrer Reward from Mention Me | received\_referrer\_reward | When a customer obtained a reward for referring a friend |
| Submitted an NPS Score from Mention Me\*\* | submitted\_nps\_score | When a customer has supplied an NPS score at post-purchase |
| Received a discount on next order from Mention Me\*\* | received\_reward\_next\_order | When a customer has received a discount to use on their next order |
| Propensity to Refer from Mention Me\*\* | propensity\_to\_refer | Each time a customer has their propensity to refer calculated |
\*\* If you have the Mention Me add-on enabled
### How to use Mention Me data in email templates
The Mention Me data can be inserted into email campaigns to create a personalised email experience using the [Bloomreach Jinja syntax](https://documentation.bloomreach.com/engagement/docs/jinja). You can use the data in the email Body, Subject line, Sender email, Sender name, Pre-header, and UTM parameters.
### Registered As A Referrer (registered\_as\_referrer)
Each time a customer registers as a referrer, a registration event will be triggered and the associated data will be sent to Bloomreach.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
| email | `{{ event.email }}` | Email used to register | [rydercollins742@mention-me.com](mailto:rydercollins742@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name | Ryder |
| surname | `{{ event.surname }}` | Surname | Collins |
| customer\_segment | `{{ event.customer_segment }}` | Segment from Mention Me tags | VIP |
| source | `{{ event.source }}` | System source | mention\_me |
| share\_link | `{{ event.share_link }}` | Referrer's share link | [https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly](https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly) |
| dashboard\_link | `{{ event.dashboard_link }}` | Referrer's tracking dashboard | [https://demo.mention-me.com/d/2674816/9c34b0c2](https://demo.mention-me.com/d/2674816/9c34b0c2) |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| locale\_code | `{{ event.locale_code }}` | Locale code | en\_GB |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Variation A |
| offer\_type | `{{ event.offer_type }}` | Type of offer | referral |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-friendly offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| referrer\_reward | `{{ event.referrer_reward }}` | Reward for the referrer | 20% |
| referee\_reward | `{{ event.referee_reward }}` | Reward for the referee | £15 |
### Registered As A Referee (registered\_as\_referee)
Each time a customer registers as a referee, a registration event will be triggered and the associated data will be sent to Bloomreach.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | ----------------------------------- | ----------------------------------------------------------------- |
| email | `{{ event.email }}` | Referee's email | [jojohnson378@mention-me.com](mailto:jojohnson378@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name (if supplied) | Joe |
| surname | `{{ event.surname }}` | Surname (if supplied) | Johnson |
| source | `{{ event.source }}` | System source | mention\_me |
| share\_source | `{{ event.share_source }}` | Share method used | FORWARDED-EMAILED-LINK |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| locale\_code | `{{ event.locale_code }}` | Locale Code | en\_GB |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Variation A |
| offer\_type | `{{ event.offer_type }}` | Type of offer | referral |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-friendly offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| fulfilled\_by | `{{ event.fulfilled_by }}` | Reward issuance method | coupon |
| reward\_amount | `{{ event.reward_amount }}` | Reward amount | 20 |
| reward\_type | `{{ event.reward_type }}` | Type of reward | percent |
| referrer\_reward | `{{ event.referrer_reward }}` | Reward for the referrer | 20% |
| referee\_reward | `{{ event.referee_reward }}` | Reward for the referee | £15 |
### Received A Referee Reward (received\_referee\_reward)
Each time a referee obtains a reward for being a referrer's friend, a referee fulfilment event will be triggered.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| email | `{{ event.email }}` | Referee's email | [jojohnson378@mention-me.com](mailto:jojohnson378@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name | Joe |
| surname | `{{ event.surname }}` | Surname | Johnson |
| source | `{{ event.source }}` | System source | mention\_me |
| referrer\_first\_name | `{{ event.referrer_first_name }}` | First name of the referrer | Ryder |
| referrer\_last\_name | `{{ event.referrer_last_name }}` | Surname of the referrer | Collins |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| locale\_code | `{{ event.locale_code }}` | Locale Code | en\_GB |
| currency\_symbol | `{{ event.currency_symbol }}` | Currency symbol | £ |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Variation A |
| offer\_type | `{{ event.offer_type }}` | Type of offer | referral |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-facing offer summary | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| fulfilled\_by | `{{ event.fulfilled_by }}` | Reward issuance method | coupon |
| reward\_amount | `{{ event.reward_amount }}` | Reward amount | 20 |
| reward\_type | `{{ event.reward_type }}` | Type of reward | percent |
| referrer\_reward | `{{ event.referrer_reward }}` | Reward for the referrer | 20% |
| referee\_reward | `{{ event.referee_reward }}` | Reward for the referee | £15 |
| coupon\_code | `{{ event.coupon_code }}` | Coupon code issued to the referee | 10USDOFF-RXAAURVZ |
| coupon\_expiry | `{{ event.coupon_expiry }}` | Coupon expiry date. Use [Jinja conversion](https://documentation.bloomreach.com/engagement/docs/filters#date--time-processing) for formatting. | 2024-09-03T16:19:19.000Z |
| call\_to\_action\_url | `{{ event.call_to_action_url }}` | URL where the customer can spend their reward | [www.mention-me.com](http://www.mention-me.com) |
### Received A Referrer Reward (received\_referrer\_reward)
Each time a referrer obtains a reward for referring a friend, a referrer fulfilment event will be triggered.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| email | `{{ event.email }}` | Referrer's email | [jojohnson378@mention-me.com](mailto:jojohnson378@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name | Joe |
| surname | `{{ event.surname }}` | Surname | Johnson |
| source | `{{ event.source }}` | System source | mention\_me |
| referee\_first\_name | `{{ event.referee_first_name }}` | First name of the referred friend | Ryder |
| referee\_last\_name | `{{ event.referee_last_name }}` | Surname of the referred friend | Collins |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| locale\_code | `{{ event.locale_code }}` | Locale Code | en\_GB |
| currency\_symbol | `{{ event.currency_symbol }}` | Currency symbol | £ |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Variation A |
| offer\_type | `{{ event.offer_type }}` | Type of offer | referral |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-facing offer summary | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| fulfilled\_by | `{{ event.fulfilled_by }}` | Reward issuance method | coupon |
| reward\_amount | `{{ event.reward_amount }}` | Reward amount | 20 |
| reward\_type | `{{ event.reward_type }}` | Type of reward | percent |
| referrer\_reward | `{{ event.referrer_reward }}` | Reward for the referrer | 20% |
| referee\_reward | `{{ event.referee_reward }}` | Reward for the referee | £15 |
| coupon\_code | `{{ event.coupon_code }}` | Coupon code issued to the referrer | 10USDOFF-RXAAURVZ |
| coupon\_expiry | `{{ event.coupon_expiry }}` | Coupon expiry date. Use [Jinja conversion](https://documentation.bloomreach.com/engagement/docs/filters#date--time-processing) for formatting. | 2024-09-03T16:19:19.000Z |
| call\_to\_action\_url | `{{ event.call_to_action_url }}` | URL where the referrer can spend their reward | [www.mention-me.com](http://www.mention-me.com) |
### Submitted An NPS Score (submitted\_nps\_score)
Each time a customer submits an NPS Score via the Mention Me NPS feature, their response will be sent to Bloomreach.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | --------------------------------- | ----------------------------------------------------------------- |
| email | `{{ event.email }}` | Email used to submit | [jojohnson378@mention-me.com](mailto:jojohnson378@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name | Joe |
| surname | `{{ event.surname }}` | Surname | Johnson |
| source | `{{ event.source }}` | System source | mention\_me |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| locale\_code | `{{ event.locale_code }}` | Locale Code | en\_GB |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Collect NPS Feedback |
| offer\_type | `{{ event.offer_type }}` | Type of offer | nps-only |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| customer\_segment | `{{ event.customer_segment }}` | Segment from Mention Me tags | VIP |
| nps\_score | `{{ event.nps_score }}` | NPS score submitted | 8 |
### Received A Discount On Next Order (received\_reward\_next\_order)
Each time a customer obtains a reward from a non-referral post-purchase message, a discount on next order fulfilment event will be triggered.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| email | `{{ event.email }}` | Customer's email | [jojohnson378@mention-me.com](mailto:jojohnson378@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name | Joe |
| surname | `{{ event.surname }}` | Surname | Johnson |
| source | `{{ event.source }}` | System source | mention\_me |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| locale\_code | `{{ event.locale_code }}` | Locale Code | en\_GB |
| currency\_symbol | `{{ event.currency_symbol }}` | Currency symbol | £ |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Variation A |
| offer\_type | `{{ event.offer_type }}` | Type of offer | referral |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| fulfilled\_by | `{{ event.fulfilled_by }}` | Reward issuance method | coupon |
| reward\_amount | `{{ event.reward_amount }}` | Reward amount | 20 |
| reward\_type | `{{ event.reward_type }}` | Type of reward | percent |
| discount\_reward | `{{ event.discount_reward }}` | Combined reward description | 20% |
| coupon\_code | `{{ event.coupon_code }}` | Coupon code | 10USDOFF-RXAAURVZ |
| coupon\_expiry | `{{ event.coupon_expiry }}` | Coupon expiry date. Use [Jinja conversion](https://documentation.bloomreach.com/engagement/docs/filters#date--time-processing) for formatting. | 2024-09-03T16:19:19.000Z |
| call\_to\_action\_url | `{{ event.call_to_action_url }}` | URL where the customer can redeem their reward | [www.mention-me.com](http://www.mention-me.com) |
### Propensity To Refer (propensity\_to\_refer)
Each time a customer has their propensity to refer calculated, their propensity value will be sent to Bloomreach. Only sent if running a Mention Me Smart Experiment.
| Field Name | Bloomreach Jinja Syntax | Description | Example |
| ----------------------------- | --------------------------------------- | --------------------------------------- | ----------------------------------------------------------------- |
| email | `{{ event.email }}` | Customer's email | [jojohnson378@mention-me.com](mailto:jojohnson378@mention-me.com) |
| firstname | `{{ event.firstname }}` | First name | Joe |
| surname | `{{ event.surname }}` | Surname | Johnson |
| source | `{{ event.source }}` | System source | mention\_me |
| campaign\_name | `{{ event.campaign_name }}` | Internal campaign name | UK Campaign |
| experiment\_name | `{{ event.experiment_name }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer\_name | `{{ event.offer_name }}` | Internal offer name | Variation A |
| offer\_type | `{{ event.offer_type }}` | Type of offer | referral |
| offer\_subject\_copy | `{{ event.offer_subject_copy }}` | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer\_call\_to\_action\_copy | `{{ event.offer_call_to_action_copy }}` | Customer-friendly CTA | Give 20% off |
| propensity\_segment | `{{ event.propensity_segment }}` | Propensity segment. Values: High or Low | High |
## ECR Data Import
Mention Me can automatically send your customers' [Extended Customer Revenue (ECR)](/knowledge/reporting/advocacy/ecr) data to your Bloomreach account. ECR is only calculated for customers who have made a successful referral.
This data is sent on a **weekly** basis and only includes customers whose ECR segment has **changed** from the previous week.
The following steps explain how to import a full set of ECR data into Bloomreach as a one-off setup before automated syncing begins.
### Step 1: Download ECR Data from Mention Me
1. Log in to the [Mention Me Platform](https://mention-me.com/login?) and go to **Customer Revenue** under the **Advocacy Intelligence** section.
2. Click the **Download customer segments** button. If you can't see the button, contact your Mention Me CSM.
3. Select all segments and click **Generate**.
It may take up to 15 minutes to generate. You'll receive an email when it's ready.
4. Click the download link in the email (you may need to log in again to Mention Me).
5. Alternatively, go to **Settings & Tools > Secure File Sharing** to download the file.
### Step 2: Create a CSV File for Bloomreach
Use any spreadsheet tool, such as Excel or Google Sheets.
1. Open the downloaded CSV file.
2. Remove the first **three rows** so only the headers remain.
3. Delete unnecessary columns:
* Individual Revenue
* Revenue Referred
* Friends ECR Value
* Report Currency Code
* First Name
* Surname
4. Rename columns:
* Email address -> **email**
* Activity Status -> **mention\_me\_ecr\_activity**
* Ecr Segment -> **mention\_me\_ecr\_status**
Column names are case-sensitive. Incorrect names will cause duplicates in Bloomreach.
5. Ensure the **email** column is first.
6. Save the file as .csv
### Step 3: Upload Your CSV to Bloomreach
For more guidance, visit [this Bloomreach help page](https://documentation.bloomreach.com/engagement/docs/customers-1).
1. In Bloomreach, go to **Data & Assets > Imports > New Import**
2. Select **Customers**
3. Click **Upload a file** and select your prepared CSV
4. Preview will load automatically. Click **Next** to proceed to mapping.
#### Data Mapping
* **De-select** the checkbox next to the email field (do not import as a property)
* **Drag** email to *hard\_id* identifier column
* **Leave** the two custom ECR fields as is -- they'll be added as customer properties
The mapping should appear as follows before you proceed:
6. Click **Run Import**
All customers who have successfully referred someone will now have an ECR segment and activity attribute added to their profile in Bloomreach. From here on, Mention Me's weekly ECR export will only update customers whose ECR status has changed.