Skip to main content

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 Emarsys enables you to receive referral and advocacy-related events in your Emarsys platform in real-time.

What the integration enables

  • Grow your contact database by sending marketing opt-ins to Emarsys in real time
  • Use referral data for personalised email campaigns and coupon reminders
  • Improve segmentation with first-party referral data
As part of the Emarsys integration setup, Mention Me automatically creates the Customer Profile attributes and the External Events needed. No manual configuration is required before enabling the integration.

Contact Data

How contacts are created

  • If the customer does not exist in your Emarsys instance, a new contact will be created.
  • If the customer does exist, the existing contact will be updated with Mention Me-specific fields only.

Customer opt-ins

When a customer opts into your newsletter via the referee journey or through a post-purchase overlay, the opt-in request will automatically be sent to Emarsys:
  • Emarsys opt-in property is set to True only if the user opts-in at registration or post-purchase.
  • If they do not opt-in, the opt-in value will not be set (null).
  • This will not be set for new Referrers.
  • A marketing consent event is sent.
  • A dedicated external event (mm:marketing_opt_in) is triggered.
Newsletter opt-in overlay from Mention Me

Customer profile attributes

System fields — Mention Me will only update the specific system fields listed below. Custom fields — Mention Me will create the custom contact fields during integration setup and update them whenever applicable data is sent.
Emarsys Contact FieldField TypeDescriptionExample
EmailSystemCustomer’s email address. Set only if a new contact is created.jason.jones@mention-me.com
First NameSystemFirst name. Only for new Referrer contacts. Not updated if value exists.Jason
Last NameSystemLast name. Only for new Referrer contacts. Not updated if value exists.Jones
CountrySystemMention Me locale code mapped to Emarsys country. Only set on creation.France
LanguageSystemMention Me locale code mapped to Emarsys language. Only set on creation.English
Opt-InSystemSet to TRUE only if customer opts in during referee journey or post-purchase newsletter. Not set for new Referrers.TRUE
Contact SourceSystemAlways “Manual Input” for contacts created by Mention Me.Manual Input
Registered DateSystemOnly set on contact creation.24.02.2023
IETFSystemMention Me locale mapped to Emarsys IETF tag. Only set on creation.en-FR
Mention Me Referred by Customer IDCustomID of the referrer who referred this referee.86277
Mention Me Referred byCustomReferrer’s name for display to the referee.Henry
Mention Me Share linkCustomReferrer’s share link to invite friends.https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly
Mention Me Dashboard linkCustomReferrer’s dashboard for viewing performance.https://demo.mention-me.com/d/2674816/9c34b0c2
Mention Me Customer IDCustomUnique ID assigned by Mention Me.33175
Mention Me Referrer IDCustomUnique ID of the Referrer. Only set for referrer contacts.86277
Mention Me Referee IDCustomUnique ID of the Referee. Only set for referee contacts.96453
Mention Me CreatedCustomTRUE if the contact was created by Mention Me.TRUE
Mention Me Is customer a Referee?CustomTRUE if the customer has registered as a Referee.TRUE
Mention Me Is customer a Referrer?CustomTRUE if the customer has registered as a Referrer.TRUE
Mention Me Referee SourceCustomMethod used to refer (e.g. OPEN-LINK, EMAIL).OPEN-LINK
Mention Me Successful ReferralsCustomTotal count of first-time purchases made via this referrer.5
Mention Me Total SharesCustomNumber of times customer shared the referral offer.10
Mention Me NPS ScoreCustomNPS score submitted at post-purchase.8
Mention Me Propensity to ReferCustomOnly sent via Smart Experiment. Values: High or LowHigh
Mention Me ECR ActivityCustomECR activity segment: Active, Dormant, LapsedActive
Mention Me ECR StatusCustomECR status: High, Medium, LowHigh
Mention Me ECR 12m PredictedCustomPredicted ECR segment in 12 months. Values: High, Medium, Low, LapsedHigh
Mention Me Network IDCustomReference to customer’s Mention Me NetworkN-5051-153480685
Mention Me First Share DateCustomDate of first share with a friend04.10.2022
Mention Me First Referral DateCustomDate of first successful referral12.10.2022
Mention Me Last Share DateCustomDate of last share06.09.2023
Mention Me Last Referral DateCustomDate of last successful referral09.10.2023
Mention Me Referrer EngagedCustomSet if referrer has engaged with an offer and accepted T&Cs.TRUE

Events

The Mention Me integration uses Emarsys external events functionality for trigger-based workflows to generate email campaigns. Mention Me automatically sets the external events in Emarsys as part of the integration setup. External events are how programs and campaigns in Emarsys can be linked to external triggers. They can be associated with actions outside Emarsys, and can be used to add contacts to an automated program or trigger mobile or email campaigns.

Summary of events sent to Emarsys

Mention Me event nameEmarsys event nameWhen it triggers
Registered as a Refereemm:referrer_registrationWhen a customer has registered as a referee
Registered as a Referrermm:referee_registrationWhen a customer has registered as a referrer
Received a Referee Rewardmm:referee_fulfillmentWhen a customer obtained a reward as a referrer’s friend
Received a Referrer Rewardmm:referrer_fulfillmentWhen a customer obtained a reward for referring a friend
Opted into Marketingmm:marketing_opt_inWhen a referee has requested to receive your newsletter at signup or post-purchase
Submitted an NPS Score**mm:nps_scoreWhen a customer has supplied an NPS score at post-purchase
Received a discount on next order**mm:discount_on_next_order_fulfillmentWhen a customer has received a discount to use on their next order
Propensity to Refer**mm:propensity_to_referEach 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 using the Emarsys Scripting Language (ESL). You can use ESL in the email body, header, preheader, subject, from name, and anywhere personalisation is supported.

Registered as a referrer (mm:referrer_registration)

Each time a customer registers as a referrer, a registration event will be triggered and the associated data will be sent to Emarsys.
AttributeEmarsys ESL FieldDescriptionExample
Customer{{event.customer.customerId}}External customer IDMI9795903142
{{event.customer.email}}Emailrydercollins742@mention-me.com
{{event.customer.firstname}}First NameRyder
{{event.customer.surname}}SurnameCollins
Customer offer{{event.customerOffer.id}}Offer ID105
{{event.customerOffer.createdDate}}Offer start date2020-04-03T09:39:08+01:00
{{event.customerOffer.expiryDate}}Offer expiry date2020-04-03T09:39:08+01:00
{{event.customerOffer.segment}}SegmentVIP
{{event.customerOffer.situation}}Where the offer was shownpostpurchase
{{event.customerOffer.shareLink}}Share linkhttps://demo.mention-me.com/m/ol/xz3uz-joel-mcfly
{{event.customerOffer.dashboardLink}}Dashboard linkhttps://demo.mention-me.com/d/2674816/9c34b0c2
Campaign{{event.campaign.id}}Campaign ID233023
{{event.campaign.shortName}}Internal campaign nameUK Campaign
{{event.campaign.state}}Campaign stateRunning
Campaign Locale{{event.campaign.locale.localeCode}}Locale Codeen_GB
{{event.campaign.locale.currencySymbol}}Currency symbol£
Experiment{{event.experiment.name}}Internal experiment nameAB Test - Current Vs New Imagery - July 2023
Offer{{event.offer.shortName}}Internal offer nameVariation A
{{event.offer.type}}Offer typereferral
{{event.offer.referrer.headline}}Customer-facing offer descriptionTreat a friend to 20% off and get 20% off for yourself
{{event.offer.referrer.cta}}Call-to-action copyGive 20% off
Reward{{event.reward.fulfilledBy}}Reward delivery methodcoupon
{{event.reward.amount}}Reward amount20
{{event.reward.type}}Reward typepercent
{{event.reward.referrerReward}}Reward for referrer20%
{{event.reward.referreeReward}}Reward for referee£15

Registered as a Referee (mm:referee_registration)

Each time a customer registers as a referee, a registration event will be triggered and the associated data will be sent to Emarsys.
AttributeEmarsys ESL FieldDescriptionExample
Referee{{event.referee.email}}Emailjojohnson378@mention-me.com
{{event.referee.firstname}}First NameJoe
{{event.referee.surname}}SurnameJohnson
{{event.referee.shareSource}}Share method usedFORWARDED-EMAILED-LINK
Referrer{{event.referrer.email}}Referrer’s emailrydercollins742@mention-me.com
{{event.referrer.firstname}}First NameRyder
{{event.referrer.surname}}SurnameCollins
Campaign{{event.campaign.shortName}}Internal campaign nameUK Campaign
Offer{{event.offer.shortName}}Internal offer nameVariation A
{{event.offer.type}}Offer typereferral
{{event.offer.referrer.headline}}Customer-facing headlineTreat a friend to 20% off and get 20% off for yourself
{{event.offer.referrer.cta}}Call-to-actionGive 20% off
Reward{{event.reward.fulfilledBy}}Reward issuance methodcoupon
{{event.reward.amount}}Reward amount20
{{event.reward.type}}Reward typepercent
{{event.reward.referrerReward}}Reward for the referrer20%
{{event.reward.referreeReward}}Reward for the referee£15

Received a referee reward (mm:referee_fulfillment)

Each time a referee obtains a reward for being a referrer’s friend, a referee fulfilment event will be triggered and the associated data will be sent to Emarsys. Includes all fields from referee registration plus:
AttributeEmarsys ESL FieldDescriptionExample
Reward{{event.reward.couponCode}}Coupon code issued to the referee10USDOFF-RXAAURVZ
{{event.reward.expiryDate|localized_date(contact.12, 'full')}}Expiry date formatted with ESL. See ESL docs.Tuesday 24 October 2034
{{event.reward.expiryDate|localized_date('en','g') - 'now'|localized_date('en','g')}}Days remaining until expiry8
{{event.reward.callToActionUrl}}URL where the customer can spend their rewardwww.mention-me.com

Received a referrer reward (mm:referrer_fulfillment)

Each time a referrer obtains a reward for referring a friend, a referrer fulfilment event will be triggered. Same structure as referee fulfilment but with referrer-specific fields (referee_first_name, referee_last_name instead of referrer names).

Opted into Marketing (mm:marketing_opt_in)

Each time a referee requests to receive your newsletter at signup or post-purchase, a dedicated event is sent to Emarsys.
AttributeFieldDescriptionExample
Customer{{event.customer.email}}Email addressrydercollins742@mention-me.com
{{event.customer.marketingOptIn}}Marketing opt-in flagTrue
Marketing{{event.marketing.source}}Source of the sign-up (newsletter-signup or referee-registration)referee-registration

Submitted an NPS Score (mm:nps_score)

Each time a customer submits an NPS Score via the Mention Me NPS feature, their response will be sent to Emarsys.
AttributeFieldDescriptionExample
NPS{{event.nps.score}}NPS score submitted8
{{event.nps.situation}}Context where score was collectedpostpurchase
{{event.nps.segment}}Customer segmentVIP

Discount on next order fulfilment (mm:discount_on_next_order_fulfillment)

Each time a customer obtains a reward from a non-referral post-purchase message, a discount on the next order fulfilment event will be triggered. Key fields include incentive-specific offer headline ({{event.offer.incentive.headline}}), CTA ({{event.offer.incentive.cta}}), coupon code, expiry, and call-to-action URL.

Propensity to refer (mm:propensity_to_refer)

Each time a customer has their propensity to refer calculated (Smart Experiment only), the propensity value will be sent to Emarsys.
AttributeFieldDescriptionExample
Propensity{{event.propensity.segment}}Propensity segment. Values: High or LowHigh

ECR Data Import

Mention Me can automatically send your customers’ Extended Customer Revenue (ECR) data to your Emarsys account. ECR is only calculated for customers who have made a successful referral. This data is sent on a weekly basis and only for customers whose ECR has changed from the previous week. The following steps explain how to import ECR data as a one-off prior to beginning the weekly updates.

Step 1: Download ECR Data from Mention Me

  1. Log in to the Mention Me Platform and go to the Customer Revenue page in the Advocacy Intelligence section.
Navigating to Customer Revenue page in Mention Me
  1. Click Download customer segments (if not visible, contact your CSM).
Download customer segments button in Mention Me
  1. Select all segments and click Generate.
Selecting ECR segments to generate CSV
  1. A CSV file will be generated (up to 15 minutes). You’ll receive an email notification when it’s ready.
  2. Click the link in the email to download (login required). You can also find the file under Settings > Secure file transfer.
Secure file transfer page in Mention Me

Step 2: Create a CSV file for Emarsys

  1. Open the file using Excel, Google Sheets, or similar tool.
  2. Remove the first 3 rows (keep headers only).
  3. Delete these 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 must be an exact match (case-sensitive), or duplicates may be created.
  1. Move the Email column to the first position.
Formatted CSV column layout for Emarsys import
  1. Save your final CSV file.

Step 3: Upload your CSV file to Emarsys

  1. Go to Contacts > Data Import in Emarsys
Contacts Data Import navigation in Emarsys
  1. Click Import File
Import File button in Emarsys
  1. Click Import file manually
Import file manually option in Emarsys
  1. Click Select a file and upload your formatted CSV.
Selecting CSV file for upload in Emarsys
  1. On the Settings screen, configure:
    • Unique Identifier = Email
    • Opt-in declarations = Status not defined
Import settings with unique identifier and opt-in configuration
  1. Click Show Advanced Settings and select Update only
Advanced settings showing Update only option
  1. No need to match columns — Mention Me fields are already created during integration.
  2. Click Next step
Column matching step in Emarsys import
  1. Click Next step again.
  2. Name the import ECR Import, click Start Import.
Naming and starting the ECR import in Emarsys
  1. Import complete! Mention Me ECR segment and activity will now be available in Emarsys.
Last modified on March 31, 2026