> ## 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.
# Klaviyo Data Reference
> Reference for all Mention Me data sent to Klaviyo, including contact profile attributes, custom events, and ECR data import.
## Overview
The Mention Me integration with Klaviyo sends referral and advocacy-related events into your Klaviyo platform in real-time.
### What the integration enables
* Send contact data and opt-ins from Mention Me referred customers to Klaviyo 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 the setup, Mention Me automatically creates the customer attributes and custom events needed. No manual configuration is required before the integration is enabled.
Events and custom attributes associated with the customer in Klaviyo are based on their email address. Mention Me sends event and contact profile attributes for any prospect or existing customer (irrespective of opt-in status) that has triggered an event via Mention Me. This is because they could have opted in via another channel.
When contact data is sent to Klaviyo:
* If a customer **already exists** in Klaviyo:
* Append their customer profile with Mention Me specific attributes
* Add Mention Me associated events to their profile
* If a customer **does not exist** in Klaviyo:
* Create the contact profile
* Append their customer profile with Mention Me specific attributes
* Add Mention Me associated events to their profile
* Add an email consent (only if explicitly captured via specific Mention Me journeys)
## Contact Data
### How contacts are created
The following rules apply when sending contact information to Klaviyo:
* Mention Me first checks if the customer already exists (using email as the identifier)
* If the customer **does not** exist on your Klaviyo account, a **new** contact will be created
* If the customer **does** exist on your Klaviyo account, the **existing** contact will be updated with only Mention Me specific fields
### Customer consent
Mention Me captures opt-ins during the referee journey or at post-purchase for a specific newsletter sign-up offer, and they can be added to a Newsletter list in Klaviyo as part of the Mention Me integration. Whenever a contact is added to the relevant newsletter list, the **Source** will be shown as Mention Me.
If your list has Double opt-in enabled, then the contact will only be added to the list once the customer has confirmed the opt-in.
The consent is tracked using the Klaviyo [subscribe tracking event](https://help.klaviyo.com/hc/en-us/articles/360037101072#h_01HRSE3YTMJ8MGF4350GCQ1ABE) based on your selected newsletter list when you [set up the integration](/knowledge/esp-crm/klaviyo/setup).
A customer can also consent to receive your newsletter via other channels outside of Mention Me, so Mention Me is not the source of truth for all your consent.
### Customer profile attributes
The following customer information is created/updated on the Klaviyo platform and can be seen on the Klaviyo profile page:
| **Klaviyo Custom Property** | **Description** | **Example** |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| Mention Me Share link | For referrer contacts only. This is the link that referrers can use to send to their friends to join your referral program. Set if a **Referrer** contact is created/updated. | [https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly](https://demo.mention-me.com/m/ol/xz3uz-joel-mcfly) |
| Mention Me Dashboard link | For referrer contacts only. This is the link that referrers can use to see how many successful referees they have had. Set if a **Referrer** contact is created/updated. | [https://demo.mention-me.com/d/2674816/9c34b0c2](https://demo.mention-me.com/d/2674816/9c34b0c2) |
| Mention Me Share Source | The name of the share method the referee came from | OPEN-LINK |
| Mention Me Referrals | Total number of successful referrals a contact has made (successful referral is defined as when the referee has made their first purchase). Includes historical referrals. | 5 |
| Mention Me Total Shares | The **total** number of shares a customer has done. Includes historical shares and all sharing methods. | 10 |
| Mention Me Shares Email | Populated if the referral has shared via this share type | 2 |
| Mention Me Shares Facebook | Populated if the referral has shared via this share type | 2 |
| Mention Me Shares Facebook Messenger | Populated if the referral has shared via this share type | 2 |
| Mention Me Shares Name Sharing | Populated if the referral has shared via this share type | 1 |
| Mention Me Shares WhatsApp | Populated if the referral has shared via this share type | 3 |
| Mention Me NPS Score | The NPS score submitted by the customer at post-purchase | 8 |
| Mention Me Propensity to Refer | Only sent if running a Mention Me **Smart Experiment**. Values: High or Low | High |
| Mention Me ECR Activity | The [Extended Customer Revenue (ECR)](/knowledge/reporting/advocacy/ecr) activity segment. Values: Active, Dormant, Lapsed | Active |
| Mention Me ECR Status | The [ECR](/knowledge/reporting/advocacy/ecr) status segment. Values: High, Medium, Low | High |
| Mention Me Network ID | Unique identifier of the [Network](/knowledge/reporting/advocacy/network-insights) that your customer belongs to | N-5051-153480685 |
| Mention Me First Share Date | Date when the referrer made their first share | 2024-06-03T16:19:08.000Z |
| Mention Me Last Share Date | Date when the referrer last shared with a friend | 2024-06-03T16:19:08.000Z |
| Mention Me First Referral Date | Date when the referrer first successfully introduced someone | 2024-06-03T16:19:08.000Z |
| Mention Me Last Referral Date | Date when the referrer last successfully introduced someone | 2024-06-03T16:19:08.000Z |
| Mention Me ECR 12m Predicted | The [Predicted ECR segment](/knowledge/reporting/advocacy/ecr) in 12 months' time. Values: High, Medium, Low, Lapsed | High |
| Mention Me Referrer Engaged | Set if the referrer has actively engaged with a referral offer and accepted T\&Cs | Yes |
| Mention Me enrolled | Set when someone registered as a referee or a referrer. Can be used to create segments identifying who has enrolled. Only set for customers created after integration was enabled. | True |
## Events
The Mention Me integration uses Klaviyo custom events (metrics) functionality for trigger-based flows to generate email campaigns or segmentations.
Mention Me automatically sets the custom events in Klaviyo as part of the integration setup.
Events are associated with a customer profile based on their email address and show under the Events section of the profile.
### Summary of events sent to Klaviyo
| Mention Me event name | When it triggers |
| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Registered as a Referee from Mention Me | When a prospective customer has registered as a referee |
| Registered as a Referrer from Mention Me | When a customer has registered as a referrer |
| Received a Referee Reward from Mention Me | When a prospective customer obtained a reward as a referrer's friend |
| Received a Referrer Reward from Mention Me | When a customer obtained a reward for referring a friend |
| Opted-in to Marketing Consent from Mention Me | When an existing or prospective customer has opted-in to receive your marketing during the referee journey or at post-purchase for a specific newsletter sign-up offer |
| Submitted an NPS Score from Mention Me\*\* | When a customer has supplied an NPS score at post-purchase |
| Received a discount on next order from Mention Me\*\* | When a customer has received a discount to use on their next order |
| Propensity to Refer from Mention Me\*\* | Each time a customer has their propensity to refer calculated, their propensity value will be sent to Klaviyo |
\*\* 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 flows to create a personalised email experience using the [Klaviyo Event Variables](https://help.klaviyo.com/hc/en-us/articles/115002779071).
You can use the data in the email Body, Subject line, Sender email, Sender name, and Pre-header.
### Registered as a referrer from Mention Me
Each time a customer registers as a referrer on the Mention Me platform, a registration event will be triggered, and the associated data will be sent to Klaviyo.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | --------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------ |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Campaign Name - not for customer-facing emails. Can be used as a filter. | UK Campaign |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | Experiment Name - not customer-facing. Can be used as a filter. | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Offer Name - not customer-facing. Can be used as a filter. | Variation A |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer being given (referral or incentive) | referral |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-friendly offer description visible on the referral offer page | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | Customer-friendly offer CTA | Give 20% off |
| Referrer Reward | `{{ event\|lookup:'Referrer Reward'\|default:'' }}` | Reward the referrer will receive, combining multiple reward types | 20% |
| Referee Reward | `{{ event\|lookup:'Referee Reward'\|default:'' }}` | Reward the referee will receive, combining multiple reward types | £15 |
### Registered as a Referee from Mention Me
Each time a customer registers as a referee on the Mention Me platform, a registration event will be triggered and the associated data will be sent to Klaviyo.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | --------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------ |
| Share Source | `{{ event\|lookup:'Share Source' }}` | The share method by which the referee was introduced | FORWARDED-EMAILED-LINK |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Campaign Name - not for customer-facing emails | UK Campaign |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | Experiment Name - not customer-facing | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Offer Name - not customer-facing | Variation A |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer being given | referral |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-friendly offer description | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | Customer-friendly offer CTA | Give 20% off |
| Fulfilled By | `{{ event\|lookup:'Fulfilled By' }}` | The method by which the reward is issued | coupon |
| Reward Amount | `{{ event\|lookup:'Reward Amount' }}` | The reward amount being offered | 20 |
| Reward Type | `{{ event\|lookup:'Reward Type' }}` | Type of reward (percent, amount, free gift) | percent |
| Referrer Reward | `{{ event\|lookup:'Referrer Reward'\|default:'' }}` | Reward the referrer will receive | 20% |
| Referee Reward | `{{ event\|lookup:'Referee Reward'\|default:'' }}` | Reward the referee will receive | £15 |
### Received a referee reward from Mention Me
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 Klaviyo.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| Referrer First Name | `{{ event\|lookup:'Referrer First Name'\|default:'' }}` | First name of the friend who referred the referee | Ryder |
| Referrer Last Name | `{{ event\|lookup:'Referrer Last Name'\|default:'' }}` | Surname of the friend who referred the referee | Collins |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Internal campaign name | UK Campaign |
| Currency Symbol | `{{ event\|lookup:'Currency Symbol' }}` | Currency symbol of the reward | £ |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Internal offer name | Variation A |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer | referral |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-facing offer summary | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | Customer-friendly CTA text | Give 20% off |
| Fulfilled By | `{{ event\|lookup:'Fulfilled By' }}` | Fulfilment mechanism for the reward | coupon |
| Reward Amount | `{{ event\|lookup:'Reward Amount' }}` | Numerical value of the reward | 20 |
| Reward Type | `{{ event\|lookup:'Reward Type' }}` | Type of reward | percent |
| Referrer Reward | `{{ event\|lookup:'Referrer Reward'\|default:'' }}` | Reward the referrer receives | 20% |
| Referee Reward | `{{ event\|lookup:'Referee Reward'\|default:'' }}` | Reward the referee receives | £15 |
| Coupon Code | `{{ event\|lookup:'Coupon Code' }}` | Coupon code assigned to the referee's reward | 10USDOFF-RXAAURVZ |
| Coupon Expiry | `{{ event\|lookup:'Coupon Expiry'\|format_date_string\|date:'d F o' }}` | Expiry date of the coupon. See [Klaviyo Date Variables](https://help.klaviyo.com/hc/en-us/articles/115005257788-How-to-Format-Date-Variables-in-Templates#populate-date-as-event-variable-in-flow-email1) to adjust formatting. | 2024-09-03T16:19:19.000Z |
| Call to Action URL | `{{ event\|lookup:'Call to Action URL' }}` | Destination URL where a customer can redeem their reward | [www.mention-me.com](http://www.mention-me.com) |
### Received a referrer reward from Mention Me
Each time a referrer obtains a reward for referring a friend, a referrer fulfilment event will be triggered and the associated data will be sent to Klaviyo.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| Referee First Name | `{{ event\|lookup:'Referee First Name'\|default:'' }}` | First name of the friend that the referrer introduced | Ryder |
| Referee Last Name | `{{ event\|lookup:'Referee Last Name'\|default:'' }}` | Surname of the friend that the referrer introduced | Collins |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Internal campaign name | UK Campaign |
| Currency Symbol | `{{ event\|lookup:'Currency Symbol' }}` | Currency symbol | £ |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | Internal experiment name | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Internal offer name | Variation A |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer | referral |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-facing offer copy | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | CTA text | Give 20% off |
| Fulfilled By | `{{ event\|lookup:'Fulfilled By' }}` | Reward issuance method | coupon |
| Reward Amount | `{{ event\|lookup:'Reward Amount' }}` | Numeric reward value | 20 |
| Reward Type | `{{ event\|lookup:'Reward Type' }}` | Reward type (percentage, fixed amount, gift) | percent |
| Referrer Reward | `{{ event\|lookup:'Referrer Reward'\|default:'' }}` | Reward for the referrer | 20% |
| Referee Reward | `{{ event\|lookup:'Referee Reward'\|default:'' }}` | Reward for the referee | £15 |
| Coupon Code | `{{ event\|lookup:'Coupon Code' }}` | Unique coupon code issued to the referrer | 10USDOFF-RXAAURVZ |
| Coupon Expiry | `{{ event\|lookup:'Coupon Expiry'\|format_date_string\|date:'d F o' }}` | Expiry date of the coupon reward. See [Klaviyo Date Variables](https://help.klaviyo.com/hc/en-us/articles/115005257788-How-to-Format-Date-Variables-in-Templates#populate-date-as-event-variable-in-flow-email1). | 2024-09-03T16:19:19.000Z |
| Call to Action URL | `{{ event\|lookup:'Call to Action URL' }}` | Link to where the reward can be used | [www.mention-me.com](http://www.mention-me.com) |
### Submitted an NPS Score from Mention Me
Each time a customer submits an NPS Score via the Mention Me NPS feature, their response will be sent to Klaviyo.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | ---------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------ |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Internal campaign reference | UK Campaign |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | Internal experiment label | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Internal offer name | Collect NPS Feedback |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer | nps-only |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-facing offer description | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | Customer-facing CTA text | Give 20% off |
| Customer Segment | `{{ event\|lookup:'Customer Segment'\|default:'' }}` | Custom segment value from Mention Me data tags | VIP |
| NPS Score | `{{ event\|lookup:'NPS Score'\|default:'' }}` | Net Promoter Score (0 to 10) | 8 |
### Received a discount on next order from Mention Me
Each time a customer obtains a reward from a non-referral post-purchase message, a "discount on next order" fulfilment event will be triggered and the associated data will be sent to Klaviyo.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Internal campaign identifier | UK Campaign |
| Currency Symbol | `{{ event\|lookup:'Currency Symbol' }}` | Symbol of the reward currency | £ |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | Internal A/B test identifier | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Internal offer label | Variation A |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer | referral |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-facing name for the offer | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | Customer-facing CTA prompt | Give 20% off |
| Fulfilled By | `{{ event\|lookup:'Fulfilled By' }}` | Reward issuance mechanism | coupon |
| Reward Amount | `{{ event\|lookup:'Reward Amount' }}` | Numeric value of the reward | 20 |
| Reward Type | `{{ event\|lookup:'Reward Type' }}` | Reward type | percent |
| Discount Reward | `{{ event\|lookup:'Discount Reward'\|default:'' }}` | Combined reward description | 20% |
| Coupon Code | `{{ event\|lookup:'Coupon Code' }}` | Unique coupon code | 10USDOFF-RXAAURVZ |
| Coupon Expiry | `{{ event\|lookup:'Coupon Expiry'\|format_date_string\|date:'d F o' }}` | Coupon expiry date. See [Klaviyo Date Variables](https://help.klaviyo.com/hc/en-us/articles/115005257788-How-to-Format-Date-Variables-in-Templates#populate-date-as-event-variable-in-flow-email1). | 2024-09-03T16:19:19.000Z |
| Call to Action URL | `{{ event\|lookup:'Call to Action URL' }}` | Link to where the reward can be redeemed | [www.mention-me.com](http://www.mention-me.com) |
### Propensity to refer from Mention Me
Each time a customer has their propensity to refer calculated, their propensity value will be sent to Klaviyo. This is only sent if you are running a Mention Me Smart Experiment.
| Field name | Klaviyo event variable | Description | Example |
| ------------------- | ------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------ |
| Campaign Name | `{{ event\|lookup:'Campaign Name' }}` | Internal campaign reference | UK Campaign |
| Experiment Name | `{{ event\|lookup:'Experiment Name' }}` | A/B test or experimental setup name | AB Test - Current Vs New Imagery - July 2023 |
| Offer Name | `{{ event\|lookup:'Offer Name' }}` | Internal offer identifier | Variation A |
| Offer Type | `{{ event\|lookup:'Offer Type' }}` | Type of offer | referral |
| Offer Subject Copy | `{{ event\|lookup:'Offer Subject Copy' }}` | Customer-facing offer copy | Treat a friend to 20% off and get 20% off for yourself |
| Call to Action Copy | `{{ event\|lookup:'Offer Call to Action Copy' }}` | Customer-facing CTA | Give 20% off |
| Propensity to Refer | `{{ event\|lookup:'Propensity to Refer'\|default:'' }}` | Calculated propensity group. High or Low. | High |
## ECR Data Import
Mention Me can automatically send your customers' Extended Customer Revenue (ECR) data to your Klaviyo 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 Klaviyo as a one-off **before** Mention Me sends the weekly updates.
### Step 1: Download ECR Data from Mention Me
1. Login to the [Mention Me Platform](https://mention-me.com/login?) and navigate to the **Customer Revenue** page in the **Advocacy Intelligence** section.
2. Click the **Download customer segments** button. If you cannot see the Download button, reach out to your CSM for help.
3. Select all segments and click **Generate**.
This will generate a CSV file that may take up to 15 minutes. You will be emailed when it's ready.
4. Click the link in the email to download the CSV file (you may be asked to log in). You can also find the file by navigating to **Settings > Secure file transfer**.
### Step 2: Create a CSV file for Klaviyo
Use Excel, Google Sheets, or another spreadsheet tool to format the CSV.
1. Open the CSV file downloaded from Mention Me
2. Remove the first 3 rows so only the headers remain
3. Remove the following columns:
* Individual Revenue
* Revenue Referred
* Friends Ecr Value
* Report Currency Code
* First Name
* Surname
4. Rename the following columns:
* Email address -> Email
* Activity Status -> Mention Me ECR Activity
* Ecr Segment -> Mention Me ECR Status
Column names are case sensitive. Mismatched names may create duplicates in Klaviyo.
5. Move the Email column to the first column. Your CSV file should now look like this:
6. Save your CSV file
### Step 3: Upload your CSV to Klaviyo
For more information, refer to [this guide](https://help.klaviyo.com/hc/en-us/articles/1260806293150).
1. Navigate to **Audience > Lists & Segments** in Klaviyo
2. Click **Create List / Segment** and choose **List**, then name it **ECR import**
3. Click **Upload Contacts**
4. Click **Upload** and select the CSV file you created
5. If the Mention Me ECR fields do not exist, click **Create New Field**
6. Use the default name with data type set to **text** for each new field
7. Your mapped fields should appear like this. Click **Next**
Repeat steps 6 & 7 for each Mention Me ECR field.
8. Choose **No, import without updating subscription status** and click **Import**
9. Your import is now complete!
All your customers who have made a successful referral will now have an ECR segment and activity assigned in Klaviyo. Going forward, Mention Me will automatically update only those customers whose ECR values have changed.