Setting up Yotpo Loyalty & Referrals – Ometria Help Centre

Ometria’s integration with Yotpo Loyalty & Referrals means that your Yotpo loyalty and referrals data can be stored against your Ometria contact’s records.

See also: Yotpo's guide for launching an on-site Loyalty & Referrals programme.

The integration works by automatically importing the live contact data into Ometria, where you can use the data to personalise your campaigns and uncover new insights to inform your marketing strategy.

Note: Due to the limitations of the Yotpo API, you'll need to upload your historical data from Yotpo into Ometria via CSV. Here is a sample CSV with headers that you can use for this task. You can also review Yotpo's documentation on exports.

If you're currently using our integration with Yotpo loyalty (via Patchworks), we recommend moving to this Ometria-native integration with Yotpo Loyalty & Referrals, which is simpler to use and set up.

If you have multiple Yotpo instances you'd like to connect with Ometria we recommend setting up each connection separately, following the steps below for every instance.

Before you begin

Set up a Yotpo Loyalty & Referral account - contact your customer success manager if you would like to be introduced to Yotpo directly.

You'll also need to create an API key in Ometria to set up your connection.

If you're planning to connect multiple Yotpo instances with Ometria then it's best to set up separate API keys for each and give them an easily recognisable name, e.g. 'Yotpo US'.

Only users with administrator account permissions can access the API keys tab.

Setting up your integration with Yotpo Loyalty & Referrals

In Ometria, go to Settings and select the Connections tab:

Screenshot_2022-04-08_at_14.27.30.png

Click Add new connection, then select Yotpo loyalty & referrals.

Screenshot_2022-04-08_at_14.28.21.png

The Ometria authentication screen displays.

Screenshot_2022-04-08_at_14.33.26.png

Select New authentication.

The Create a new authentication window displays:

Screenshot_2022-04-08_at_09.59.12.png

Enter the API key you created at the beginning of the process and select Create.

The Yotpo Loyalty Authentication screen displays:

Screenshot_2022-04-08_at_14.34.40.png

Click New authentication.

The Create a new authentication pop-up displays:

Screenshot_2022-04-08_at_14.37.16.png

Change Your authentication name if you wish. This name will help you identify any other Yotpo accounts you might have added in Ometria.

Enter the GUID and API key previously created in your Yotpo Loyalty & Referrals account and click Create.

Once the authentication is successful, click Next to reach the Yotpo Loyalty & Referrals webhook screen:

Screenshot_2022-04-08_at_14.38.03.png

Copy the Webhook URL and log into your Yotpo Loyalty & Referrals admin account.

Screenshot_2022-04-08_at_10.05.24.png

In Yotpo, go to Settings > General Settings and paste the URL into the Yotpo Webhook URL field:

Screenshot_2022-04-08_at_14.39.26.png

Note: If you already have a webhook registered, you can add this one in the same field by separating the URLs using semicolons (;).

Save these changes in Yotpo, then return to Ometria.

Select Finish.

Your Yotpo Loyalty & Referrals connection is set up.

Next you'll need to raise a request with the Support team to get your custom events set up. After that, Ometria's Creative team will need to add the triggers to your email templates.

Screenshot_2022-04-08_at_14.40.20.png

Data passed to Ometria

Ometria retrieves two types of data from Yotpo Loyalty & Referrals:

Custom fields - fields you create manually in Ometria.
Default fields - fields that already exist in Ometria's database.

Create your custom fields

Once your Yotpo Loyalty & Reviews connection is set up in Ometria, you'll need to create the custom fields below for retrieving the data.

You only need to create the fields that you think will provide value to your marketing strategy.

Follow the steps in Create a custom field to set up the following:

Category	Field ID	Field title	Description	Type	Example
Contact	yotpo_lifetime_points	Yotpo lifetime points	All the points the contact has gained since joining your loyalty scheme.	Integer	1,000 points
Contact	yotpo_remaining_points	Yotpo remaining points	The contact's total available points at present.	Integer	675 points
Contact	yotpo_points_expire_at	Yotpo points expiration date	The date the contact's remaining points will expire.	Date	2022-08-25
Contact	yotpo_referral_link	Yotpo referral link	For referrer contacts only. This is the link that referrers send to their friends to join your referral program.	String	http://rwrd.io/x09u052
Contact	yotpo_successful_referrals	Yotpo successful referrals	The number of successful referrals for this contact. Note: Success is defined by your team in Yotpo - e.g. the referral made a purchase.	Integer	4
Contact	new_tier	Yotpo loyalty tier	The loyalty tier the contact belongs to.	String	Platinum
Contact	yotpo_loyalty_enroll_date	Yotpo enroll date	The date when the contact signed up to your loyalty programme.	Date	2021-03-22
Contact	yotpo_timestamp_updated	Yotpo Loyalty programme updated	The date there was a change in the loyalty programme.	Date	2022-03-25

Default fields

Field	Description
Email	The email address the lead provides in the “email” field in your ad.
Date of birth	The date information the lead provides in the “Date of birth” field in the loyalty scheme form.
Collection	This field is for API GET request purposes and does not display in Ometria. It refers to the collection the contact belongs to - in this case, 'yotpo_loyalty'.

Event triggers

The following custom events are available for triggering your Yotpo-powered automation campaigns:

Custom Event	Label
`yotpo_points_changed`	Yotpo points changed
`yotpo_customer_birthday`	Yotpo customer birthday
`yotpo_customer_anniversary_captured`	Yotpo customer anniversary captured
`yotpo_customer_anniversary`	Yotpo customer anniversary
`yotpo_tier_earn`	Yotpo tier earn
`yotpo_tier_lost`	Yotpo tier lost
`yotpo_points_earned`	Yotpo points earned
`yotpo_points_reminder`	Yotpo points reminder
`yotpo_coupon_earned_redeemed`	Yotpo coupon earned redeemed
`yotpo_redemption_reminder`	Yotpo redemption reminder
`yotpo_referral_link_share`	Yotpo referral link share
`yotpo_referral_share_reminder`	Yotpo referral share reminder
`yotpo_referral_product_share`	Yotpo referral product share
`yotpo_referral_product_share_reminder`	Yotpo referral product share reminder

Use cases

Increasing loyalty is not an easy task, but now that you have the Yotpo data in Ometria, let’s find powerful reports, segmentation and campaigns to take advantage of it.

Read on for some ideas and suggestions on how to improve your customer loyalty in Ometria.

Automation campaigns

Points reminder

Set up a campaign to remind your customers how many loyalty points they have available using the entry trigger:

The contact has… changed segment membership - which is - Accumulator Point Reminder.

Points confirmation

Set up a campaign to let your customers know how many loyalty points they have after placing an order by using the entry trigger:

The contact has… a custom date field that matches - Last purchase date - Is today

New tier confirmation

Set up a campaign to let your customers know when they have moved into a new loyalty tier by using the entry trigger:

The contact has… changed segment membership - Which is - [select your loyalty tier]

Loyalty welcome

Set up a campaign to thank your customers for opting into your loyalty programme by using the entry trigger:

The contact has… a custom date field that matches - Loyalty Optin In Date - Is today

Broadcast campaigns - dynamic blocks

Configure your broadcast campaign templates to display only for contacts in your loyalty tier segments and tailor the information specifically to them:

Example CSV for historical data

Yotpo product loyalty template - Sheet1.csv
516 Bytes Download