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.
Overview
The Mention Me integration with Braze allows you to gather insights related to referrals and advocacy directly within your Braze platform in real time.
What the integration enables
- Send contact data and opt-ins from Mention Me referred customers to Braze instantly
- Utilise referral data to create coupon email reminders
- Improve the effectiveness of your marketing channels by using referral and advocacy data to segment and target valuable customers
During setup, Mention Me creates the necessary customer attributes and events in Braze. No manual configuration is required.
Events and custom attributes linked to customers in Braze are matched by their email address. Mention Me sends data for any customer (prospect or existing), regardless of opt-in status, who has triggered an event through the Mention Me platform.
Braze handles the customer profile as follows:
- If the customer already exists:
- Append Mention Me-specific attributes to their profile
- Add Mention Me-related events to their profile
- If the customer does not exist:
- Create the contact using their email address
- Assign Mention Me-specific attributes
- Add events from Mention Me
- Optionally set email channel subscription status if consented through Mention Me journeys
Using External ID as Customer Identifier
If you’re using an external ID (instead of an email) as the primary identifier in Braze:
- If a customer already exists in Braze with both external ID and email, Mention Me data will augment the existing contact.
- If Mention Me creates the profile first (e.g., when the customer refers someone), it won’t include the external ID.
- When your system adds a new profile using the external ID, Braze will not merge it with the Mention Me-created profile, creating a duplicate.
To avoid duplicate profiles, use Braze’s Bulk Merge feature, which can be scheduled daily.
Customer consent
You may collect newsletter opt-in consent through the Mention Me journey. This consent is auto-forwarded to Braze without the need for CSV uploads.
If a customer agrees to receive your newsletter during the Mention Me referee journey or post-purchase overlay, the opt-in is automatically sent to Braze.
Customers who consent will be marked as opted-in on the email channel. Those who do not will still be signed up, but set to subscribed.
A custom event called marketing_consent will be added to their Braze profile to indicate newsletter opt-in via Mention Me.
Customers may also give consent through other sources outside Mention Me, so Mention Me may not be the sole source of consent data.
Customer profile attributes
Mention Me creates or updates the following fields in Braze:
| Braze Customer Field | Description | Example |
|---|
| mention_me_share_link | Referral link for referrers to share. Set when a Referrer contact is created or updated. | https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly |
| mention_me_dashboard_link | Dashboard link for referrers to track performance. | https://demo.mention-me.com/d/2674816/9c34b0c2 |
| mention_me_share_source | Original sharing method used by the referee. | OPEN-LINK |
| mention_me_referrals | Total successful referrals made by the user (historical + recent). | 5 |
| mention_me_total_shares | Total number of shares (all channels, all time). | 10 |
| mention_me_email_shares | Shares made via email. | 2 |
| mention_me_fb_shares | Shares made via Facebook. | 2 |
| mention_me_fb_mess_shares | Shares made via Facebook Messenger. | 2 |
| mention_me_name_shares | Shares made by entering a name directly. | 1 |
| mention_me_whatsapp_shares | Shares made via WhatsApp. | 3 |
| mention_me_native_shares | Shares made using the device’s native sharing function. | 4 |
| mention_me_nps_score | NPS score submitted by the customer post-purchase. | 8 |
| mention_me_propensity_to_refer | Smart Experiment value indicating referral tendency (High/Low). | High |
| mention_me_referrer_engaged | Set if the referrer agreed to T&Cs when engaging a referral offer. | True |
| mention_me_first_share_date | The date of the first referral share. | Apr 16 2025 8:33 am -04:00 |
| mention_me_first_referral_date | Date of the first successful referral. | Apr 16 2025 8:33 am -04:00 |
| mention_me_last_share_date | Most recent date the referrer shared a link. | Apr 16 2025 8:33 am -04:00 |
| mention_me_last_referral_date | Last successful referral date. | Apr 16 2025 8:33 am -04:00 |
| mention_me_ecr_predicted | Predicted ECR segment in 12 months. Values: High, Medium, Low, Lapsed | High |
| mention_me_ecr_activity | ECR activity segment. Values: Active, Dormant, Lapsed | Active |
| mention_me_ecr_status | Current ECR status segment. Values: High, Medium, Low | High |
| mention_me_network_id | Unique network ID identifier for the customer’s referral network. | N-5051-153480685 |
Events
The Mention Me integration uses Braze custom events functionality for trigger-based scenarios to generate email campaigns or segmentations.
Mention Me automatically sets the custom events in Braze as part of the integration setup.
Events are associated with a customer profile based on their email address and show under the Custom Events section of the profile.
Summary of events
| Braze event name | When it triggers |
|---|
| registered_as_referee | When a customer has registered as a referee |
| registered_as_referrer | When a customer has registered as a referrer |
| received_referee_reward | When a customer obtained a reward as a referrer’s friend |
| received_referrer_reward | When a customer obtained a reward for referring a friend |
| marketing_consent | When an existing or prospective customer has opted-in to receive marketing during the referee journey or at post-purchase |
| submitted_nps_score | When a customer has supplied an NPS score at post-purchase |
| received_reward_next_order | When a customer has received a discount to use on their next order |
| 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 Canvas Email templates
The Mention Me data can be inserted into Canvas email campaigns to create a personalised email experience using Liquid Scripting as canvas_entry_properties.
You can use the data in a drag-and-drop email Body and subject line.
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 Braze.
| Field name | Description | Example |
|---|
| customer_segment | Segment value passed via Mention Me tags | VIP |
| source | System source for this event | mention_me |
| share_link | Referrer’s share link to invite friends | https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly |
| dashboard_link | Referrer dashboard for tracking referrals | https://demo.mention-me.com/d/2674816/9c34b0c2 |
| campaign_name | Internal campaign name (not for customer-facing emails) | UK Campaign |
| locale_code | Locale (country) where the referrer enrolled | en_GB |
| experiment_name | Internal experiment name (not customer-facing) | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name (not customer-facing) | Variation A |
| offer_type | Type of offer (referral or incentive) | referral |
| offer_subject_copy | Customer-friendly offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly offer CTA | Give 20% off |
| referrer_reward | Reward the referrer will receive (combined types) | 20% |
| referee_reward | Reward the referee will receive (combined types) | £15 |
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 Braze.
| Field name | Description | Example |
|---|
| source | System source | mention_me |
| share_source | Share method by which the referee was introduced | FORWARDED-EMAILED-LINK |
| campaign_name | Internal campaign name | UK Campaign |
| locale_code | Locale Code | en_GB |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Variation A |
| offer_type | Type of offer | referral |
| offer_subject_copy | Customer-friendly offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly offer CTA | Give 20% off |
| fulfilled_by | Reward issuance method | coupon |
| reward_amount | Reward amount offered | 20 |
| reward_type | Type of reward (percent, amount, free gift) | percent |
| referrer_reward | Reward for the referrer | 20% |
| referee_reward | Reward for the referee | £15 |
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 | Description | Example |
|---|
| source | System source | mention_me |
| referrer_first_name | First name of the referring friend | Ryder |
| referrer_last_name | Surname of the referring friend | Collins |
| campaign_name | Internal campaign name | UK Campaign |
| locale_code | Locale Code | en_GB |
| currency_symbol | Currency symbol | £ |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Variation A |
| offer_type | Type of offer | referral |
| offer_subject_copy | Customer-facing offer summary | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly CTA | Give 20% off |
| fulfilled_by | Reward issuance method | coupon |
| reward_amount | Reward amount | 20 |
| reward_type | Type of reward | percent |
| referrer_reward | Reward for the referrer | 20% |
| referee_reward | Reward for the referee | £15 |
| coupon_code | Coupon code for the referee’s reward | 10USDOFF-RXAAURVZ |
| coupon_expiry | Expiry date (UTC). Use Liquid conversion for formatting. | 2024-09-03T16:19:19.000Z |
| call_to_action_url | URL where the customer can spend their reward | www.mention-me.com |
received_referrer_reward
Each time a referrer obtains a reward for referring a friend, a referrer fulfilment event will be triggered.
| Field name | Description | Example |
|---|
| source | System source | mention_me |
| referee_first_name | First name of the referred friend | Ryder |
| referee_last_name | Surname of the referred friend | Collins |
| campaign_name | Internal campaign name | UK Campaign |
| locale_code | Locale Code | en_GB |
| currency_symbol | Currency symbol | £ |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Variation A |
| offer_type | Type of offer | referral |
| offer_subject_copy | Customer-facing offer copy | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly CTA | Give 20% off |
| fulfilled_by | Reward issuance method | coupon |
| reward_amount | Reward amount | 20 |
| reward_type | Type of reward | percent |
| referrer_reward | Reward for the referrer | 20% |
| referee_reward | Reward for the referee | £15 |
| coupon_code | Coupon code for the referrer’s reward | 10USDOFF-RXAAURVZ |
| coupon_expiry | Expiry date (UTC). Use Liquid conversion for formatting. | 2024-09-03T16:19:19.000Z |
| call_to_action_url | URL where the referrer can spend their reward | www.mention-me.com |
marketing_consent
When a referee requests to receive your newsletter at signup or if an existing customer has signed up post-purchase, an event will be sent to Braze.
| Field name | Description | Example |
|---|
| source | System source | mention_me |
| campaign_name | Internal campaign name | UK Campaign |
| locale_code | Locale Code | en_GB |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Variation 1 |
| offer_type | Type of offer | nps-only |
| offer_subject_copy | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly CTA | Give 20% off |
| customer_segment | Segment value from Mention Me tags | VIP |
| consent_source | Source of the newsletter sign-up (newsletter-signup or referee-registration) | referee-registration |
submitted_nps_score
Each time a customer submits an NPS Score via the Mention Me NPS feature, their response will be sent to Braze.
| Field name | Description | Example |
|---|
| source | System source | mention_me |
| campaign_name | Internal campaign name | UK Campaign |
| locale_code | Locale Code | en_GB |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Collect NPS Feedback |
| offer_type | Type of offer | nps-only |
| offer_subject_copy | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly CTA | Give 20% off |
| customer_segment | Segment value from Mention Me tags | VIP |
| nps_score | The NPS response submitted | 8 |
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 | Description | Example |
|---|
| source | System source | mention_me |
| campaign_name | Internal campaign name | UK Campaign |
| locale_code | Locale Code | en_GB |
| currency_symbol | Currency symbol | £ |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Variation A |
| offer_type | Type of offer | referral |
| offer_subject_copy | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly CTA | Give 20% off |
| fulfilled_by | Reward issuance method | coupon |
| reward_amount | Reward amount | 20 |
| reward_type | Type of reward | percent |
| discount_reward | Combined reward description | 20% |
| coupon_code | Coupon code | 10USDOFF-RXAAURVZ |
| coupon_expiry | Coupon expiry date. Use Liquid conversion for formatting. | 2024-09-03T16:19:19.000Z |
| call_to_action_url | URL where the customer can redeem their reward | www.mention-me.com |
propensity_to_refer
Each time a customer has their propensity to refer calculated, their propensity value will be sent to Braze. Only sent if you are running a Mention Me Smart Experiment.
| Field name | Description | Example |
|---|
| source | System source | mention_me |
| campaign_name | Internal campaign name | UK Campaign |
| experiment_name | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| offer_name | Internal offer name | Variation A |
| offer_type | Type of offer | referral |
| offer_subject_copy | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| offer_call_to_action_copy | Customer-friendly CTA | Give 20% off |
| propensity_segment | Propensity segment. Values: High or Low | High |