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 Ometria enables you to receive referral and advocacy-related events into your Ometria platform in real time.
What the integration enables
- Send contact data and opt-ins from Mention Me referred customers to Ometria in real-time
- Use referral data to create coupon email reminders
- Enhance the performance of other marketing channels by using referral and advocacy data to segment and target high-value customers
As part of setup, Ometria creates the customer attributes and custom events needed. No manual configuration is required before requesting the integration.
Events and custom attributes are based on the customer’s email address. Mention Me sends event and contact profile attributes for any prospect or existing customer (regardless of opt-in status) who triggers an event via Mention Me.
When contact data is sent to Ometria:
- If a customer already exists in Ometria:
- Append their customer profile with Mention Me specific attributes
- Add Mention Me associated events to their profile
- If a customer does not exist in Ometria:
- Create the contact profile with their email address
- Append their customer profile with Mention Me specific attributes
- Add Mention Me associated events to their profile
- Set the email subscription status (only if explicitly captured via specific Mention Me journeys)
- Mention Me first checks if the customer already exists (using email as the identifier)
- If the customer does not exist, a new contact will be created
- If the customer does exist, the existing contact will be updated with only Mention Me specific fields
Customer consent
If a customer consents to your newsletter via the Mention Me referee journey or via a newsletter post-purchase overlay, the opt-in request will automatically be sent to Ometria.
During installation setup, your Mention Me CSM/Support Team will ask which Segment you’d like Mention Me-sourced opt-ins added to. New opt-ins will automatically be added to the segment.
A dedicated event called Opted in to Marketing Consent (Mention Me) is sent to Ometria. The consent source values are:
- mention_me_referee = From the referee journey
- mention_me_newsletter = From a post-purchase journey
A customer can also consent via other channels outside of Mention Me.
Customer profile attributes
| Ometria Field ID | Ometria Field Name | Description | Example |
|---|
| mm:share_link | Share link (Mention Me) | Referrer’s share link to invite friends | https://demo.mention-me.com/m/ol/mr4lk-alicia-winder |
| mm:dashboard_link | Dashboard link (Mention Me) | Referrer’s dashboard for tracking referrals | https://demo.mention-me.com/d/2252151/58fde3c14a72… |
| mm:referred_by_firstname | Referred by name (Mention Me) | First name of the person who referred the referee | John |
| mm:referrals | Total referrals (Mention Me) | Total successful referrals (first-time purchases by referee) | 10 |
| mm:total_shares | Total shares (Mention Me) | Total shares since registering as a referrer | 15 |
| mm:share_email | Shares email (Mention Me) | Shares made via email | 3 |
| mm:share_facebook | Shares facebook (Mention Me) | Shares via Facebook | 4 |
| mm:share_fbmessenger | Shares facebook messenger (Mention Me) | Shares via Facebook Messenger | 5 |
| mm:share_name | Shares name sharing (Mention Me) | Shares from Name Sharing | 2 |
| mm:share_whatsapp | Shares whatsapp (Mention Me) | Shares via WhatsApp | 1 |
| mm:share_native | Shares native (Mention Me) | Shares from Native Sharing | 2 |
| mm:last_share_date | Last share date (Mention Me) | Last time the referrer shared | 2024-09-12T14:55:58.000Z |
| mm:first_share_date | First share date (Mention Me) | Date of first share | 2024-09-12T14:55:58.000Z |
| mm:last_referral_date | Last referral date (Mention Me) | Last successful referral date | 2024-09-12T14:55:58.000Z |
| mm:first_referral_date | First referral date (Mention Me) | Date of first successful referral | 2024-09-12T14:55:58.000Z |
| mm:referrer_engaged | Referrer engaged (Mention Me) | True if referrer engaged with offer and accepted terms | True |
| mm:propensity_to_refer | Propensity to refer (Mention Me) | Propensity value: High or Low | High |
| mm:nps_score | NPS score (Mention Me) | NPS Score submitted | 8 |
| mm:ecr_status | ECR status (Mention Me) | ECR segment: High, Medium, Low | High |
| mm:ecr_activity | ECR activity (Mention Me) | ECR activity: Active, Dormant, Lapsed | Active |
| mm:12m_predicted | ECR predicted (Mention Me) | Predicted ECR in 12 months: High, Medium, Low, Lapsed | Lapsed |
| mm:network_id | Network ID (Mention Me) | Mention Me Network identifier | N-4339-5558776 |
Events
The Mention Me integration uses Ometria custom events functionality for trigger-based scenarios to generate email campaigns or segmentations. Ometria creates the Custom Events during setup.
Events are associated with a customer profile based on their email address.
Custom events can be used to add contacts to an Automation, trigger email campaigns, or create dynamic segments.
The Mention Me data can be inserted into email campaigns using Ometria Merge Tags.
Summary of events sent to Ometria
| Ometria event name | Ometria event ID | When it triggers |
|---|
| Registered as a referee (Mention Me) | mm:registration_referee | When a customer has registered as a referee |
| Registered as a referrer (Mention Me) | mm:registration_referrer | When a customer has registered as a referrer |
| Obtained a reward as a referee (Mention Me) | mm:fulfillment_referee | When a customer obtained a reward as a referrer’s friend |
| Obtained a reward for referring a friend (Mention Me) | mm:fulfillment_referrer | When a customer obtained a reward for referring a friend |
| Opted in to Marketing Consent (Mention Me) | mm:marketing_consent | When a customer has opted-in to receive marketing |
| Submitted NPS Score (Mention Me)** | mm:nps_score | When a customer has supplied an NPS score at post-purchase |
| Obtained a Reward for next order (Mention Me)** | mm:discount_next_order | When a customer has received a discount to use on their next order |
| Propensity to Refer (Mention Me) | mm:propensity_to_refer | Each time a customer’s propensity to refer is calculated |
Registered as a referrer (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:locale | {{ event['mm:locale'] }} | Website locale | en_GB |
| mm:reward:amount | {{ event['mm:reward:amount'] }} | Reward amount | 20 |
| mm:referrer_reward | {{ event['mm:referrer_reward'] }} | Reward for the referrer | 20% |
| mm:reward:type | {{ event['mm:reward:type'] }} | Type of reward | percent |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-friendly CTA | Get £10 off |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_type | {{ event['mm:offer_type'] }} | Type of offer | referral |
| mm:referee_reward | {{ event['mm:referee_reward'] }} | Reward for the referee | 20% |
| mm:dashboard_link | {{ event['mm:dashboard_link'] }} | Referrer’s tracking dashboard | https://demo.mention-me.com/d/2252151/58fde3c1… |
| mm:share_link | {{ event['mm:share_link'] }} | Referral share link | https://demo.mention-me.com/m/ol/mr4lk-alicia-winder |
| mm:segment | {{ event['mm:segment'] }} | Segment from Mention Me tags | VIP |
Registered as a referee (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:locale | {{ event['mm:locale'] }} | Website locale | en_GB |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:reward:amount | {{ event['mm:reward:amount'] }} | Reward amount | 20 |
| mm:referee_reward | {{ event['mm:referee_reward'] }} | Reward for the referee | 20% |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-friendly CTA | Get £10 off |
| mm:offer_type | {{ event['mm:offer_type'] }} | Type of offer | referral |
| mm:fufilled_by | {{ event['mm:fufilled_by'] }} | Reward issuance mechanism | coupon |
| mm:reward:type | {{ event['mm:reward:type'] }} | Type of reward | percent |
| mm:referrer_reward | {{ event['mm:referrer_reward'] }} | Reward for the referrer | 20% |
| mm:share_source | {{ event['mm:share_source'] }} | Share method used | WHATSAPP |
Obtained a reward as a referee (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:call_to_action_url | {{ event['mm:call_to_action_url'] }} | URL to redeem reward | http://www.mention-me.com |
| mm:reward:amount | {{ event['mm:reward:amount'] }} | Reward amount | 20 |
| mm:reward:type | {{ event['mm:reward:type'] }} | Type of reward | Percent |
| mm:coupon | {{ event['mm:coupon'] }} | Coupon code | DEMO-58983 |
| mm:coupon_link | {{ event['mm:coupon_link'] }} | Link to retrieve coupon | http://spend.reward.com/85544-456544-65455-555 |
| mm:coupon_expiry | {{ event['mm:coupon_expiry'] }} | Coupon expiry date | 2020-07-30T18:26:07+01:00 |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:referred_by_firstname | {{ event['mm:referred_by_firstname'] }} | Referrer’s first name | Jonathan |
| mm:referred_by_customer_id | {{ event['mm:referred_by_customer_id'] }} | Referrer’s customer ID | CI5990618295 |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:locale | {{ event['mm:locale'] }} | Locale | en_GB |
| mm:referee_reward | {{ event['mm:referee_reward'] }} | Aggregated referee reward | 20% |
| mm:referred_by_lastname | {{ event['mm:referred_by_lastname'] }} | Referrer’s last name | Smith |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-facing CTA | Get £10 off |
| mm:offer_type | {{ event['mm:offer_type'] }} | Type of offer | referral |
| mm:fufilled_by | {{ event['mm:fufilled_by'] }} | Fulfilment method | coupon |
| mm:referrer_reward | {{ event['mm:referrer_reward'] }} | Reward for the referrer | 20% |
| mm:currency | {{ event['mm:currency'] }} | Currency symbol | £ |
Obtained a reward for referring a friend (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:call_to_action_url | {{ event['mm:call_to_action_url'] }} | URL to redeem reward | http://www.mention-me.com |
| mm:reward:amount | {{ event['mm:reward:amount'] }} | Reward amount | 20 |
| mm:reward:type | {{ event['mm:reward:type'] }} | Type of reward | Percent |
| mm:coupon | {{ event['mm:coupon'] }} | Coupon code | DEMO-58983 |
| mm:coupon_link | {{ event['mm:coupon_link'] }} | Link to retrieve coupon | http://spend.reward.com/85544-456544-65455-555 |
| mm:coupon_expiry | {{ event['mm:coupon_expiry'] }} | Coupon expiry date | 2020-07-30T18:26:07+01:00 |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:locale | {{ event['mm:locale'] }} | Locale | en_GB |
| mm:referrer_reward | {{ event['mm:referrer_reward'] }} | Total referrer reward | 20% |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-facing CTA | Get £10 off |
| mm:offer_type | {{ event['mm:offer_type'] }} | Type of offer | referral |
| mm:fufilled_by | {{ event['mm:fufilled_by'] }} | Fulfilment method | coupon |
| mm:referee_reward | {{ event['mm:referee_reward'] }} | Reward for the referee | 20% |
| mm:currency | {{ event['mm:currency'] }} | Currency symbol | £ |
| mm:referee_first_name | {{ event['mm:referee_first_name'] }} | Referee’s first name | Jonathan |
| mm:referee_last_name | {{ event['mm:referee_last_name'] }} | Referee’s last name | Jones |
Submitted NPS Score (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:locale | {{ event['mm:locale'] }} | Website locale | en_GB |
| mm:nps_score | {{ event['mm:nps_score'] }} | NPS score submitted | 8 |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:segment | {{ event['mm:segment'] }} | Segment from Mention Me tags | VIP |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-friendly CTA | Get £10 off |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
| mm:offer_type | {{ event['mm:offer_type'] }} | Type of offer | nps-only |
Obtained a Reward for the next order (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:coupon | {{ event['mm:coupon'] }} | Coupon code | DEMO-58983 |
| mm:coupon_expiry | {{ event['mm:coupon_expiry'] }} | Coupon expiry date | 2020-07-30T18:26:07+01:00 |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:locale | {{ event['mm:locale'] }} | Website locale | en_GB |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:incentive_reward | {{ event['mm:incentive_reward'] }} | Reward for the customer | 20% |
| mm:call_to_action_url | {{ event['mm:call_to_action_url'] }} | URL to redeem reward | http://www.mention-me.com |
| mm:reward:amount | {{ event['mm:reward:amount'] }} | Reward amount | 20 |
| mm:reward:type | {{ event['mm:reward:type'] }} | Type of reward | percent |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-facing CTA | Get £10 off |
| mm:offer_type | {{ event['mm:offer_type'] }} | Type of offer | referral |
| mm:fufilled_by | {{ event['mm:fufilled_by'] }} | Fulfilment method | coupon |
| mm:currency | {{ event['mm:currency'] }} | Currency symbol | £ |
Propensity to Refer (Mention Me)
Only sent if running a Mention Me Smart Experiment.
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:locale | {{ event['mm:locale'] }} | Website locale | en_GB |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:propensity_to_refer | {{ event['mm:propensity_to_refer'] }} | Propensity segment. Values: High or Low | High |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-friendly CTA | Get £10 off |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
Opted in to Marketing Consent (Mention Me)
| Field name | Ometria Merge Tag | Description | Example |
|---|
| mm:campaign_id | {{ event['mm:campaign_id'] }} | Campaign ID | 33463 |
| mm:locale | {{ event['mm:locale'] }} | Website locale | en_GB |
| mm:offer_id | {{ event['mm:offer_id'] }} | Offer ID | 115912 |
| mm:consent_source | {{ event['mm:consent_source'] }} | Source: newsletter-signup or referee-registration | newsletter-signup |
| mm:campaign_short_name | {{ event['mm:campaign_short_name'] }} | Internal campaign name | Referral Landing Page |
| mm:experiment_name | {{ event['mm:experiment_name'] }} | Internal experiment name | New Imagery March 2021 |
| mm:offer_cta_copy | {{ event['mm:offer_cta_copy'] }} | Customer-facing CTA | Get £10 off |
| mm:offer_short_name | {{ event['mm:offer_short_name'] }} | Internal offer name | Variation 1 |
| mm:offer_subject_copy | {{ event['mm:offer_subject_copy'] }} | Customer-facing offer description | Treat a friend to 15% off and get £10 off for yourself |
| mm:offer_summary | {{ event['mm:offer_summary'] }} | Internal offer summary | Referrer gets £10 off. Referee gets 15% off |
ECR Data Import
Mention Me can automatically send your customers’ Extended Customer Revenue (ECR) data to your Ometria account. ECR is only calculated for customers who have made a successful referral.
This data is scheduled to be sent on a weekly basis and will only send ECR data for customers whose ECR has changed from the previous week.
The following steps explain how to import all your customers’ ECR data into Ometria as a one-off before Mention Me begins weekly updates.
Step 1: Download ECR Data from Mention Me
- Login to the Mention Me Platform and navigate to the Customer Revenue page in the Advocacy Intelligence section.
- Click the Download customer segments button. If not visible, contact your CSM.
- Select all segments and click Generate.
The CSV file will take around 15 minutes to generate. You will receive an email when it’s ready.
- Click the link in the email to download the file (login may be required). Or download from Settings > Secure file transfer.
Step 2: Create a CSV file for Ometria
- Open the file downloaded from Mention Me
- Remove the first 3 rows so only the headers remain
- Remove the following columns: Individual Revenue, Revenue Referred, Friends ECR Value, Report Currency Code, First Name, Surname
- Rename columns:
- Email address -> email
- Activity Status -> properties.mm:ecr_activity
- Ecr Segment -> properties.mm:ecr_status
Column names are case sensitive. Incorrect names may cause duplicates.
- Move the email column to be the first column.
- Save your CSV file
Step 3: Upload your CSV to Ometria
For more information, read this guide.
- In the Ometria platform, navigate to your Account Name > Contact upload
- Click Select CSV File and locate your saved file
- Select No to adding contacts to a Segment
- Leave Merge Mode ticked (only updates ECR fields, preserves other data)
- Select Unchanged for Email and Subscription mode (preserves customer’s opt-in status)
- Confirm both Data Privacy checkboxes
- Press Upload. It may take up to 24 hours to complete. Ometria will notify you by email.
- Your import is now complete!
All customers who have made a successful referral will now have an ECR segment and activity reflected in their Ometria profile.
