> ## Documentation Index
> Fetch the complete documentation index at: https://moengage.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Yotpo

# Introduction

[Yotpo](https://www.yotpo.com/) is a cloud-based content marketing platform for e-commerce businesses that enables users to collect user-generated content and use the content to build a brand and manage the customer experience.

# MoEngage × Yotpo

With the MoEngage and Yotpo integration, you can display star ratings, top reviews, user-generated content (UGC), and customer loyalty data dynamically using Content APIs inside MoEngage campaigns across various channels like emails and push.

# Integration

<Info>
  * Ensure you have access to use Yotpo APIs.
  * Ensure you have your Yotpo reviews API key. [Read more](https://support.yotpo.com/en/article/finding-your-yotpo-app-key-and-secret-key)
  * Ensure you have your Yotpo loyalty API key. [Read more](https://support.yotpo.com/en/article/finding-your-loyalty-referrals-api-key-and-guid)
</Info>

## Set up a MoEngage Content API

We will use Yotpo's REST API to insert personalized content into your campaigns. This can be done by adding Yotpo's Rest API endpoints in MoEngage Content APIs.

Perform the following steps:

1. Navigate to **Settings** -> **Advanced settings** -> **Content API**. Click **+ Add content API** at the top right corner of the Content API screen.

<img src="https://mintcdn.com/moengage/syqICryKE0qygh49/images/partner_21979592722196.png?fit=max&auto=format&n=syqICryKE0qygh49&q=85&s=9cacd5024d2de8e986a259a5a4f0711a" alt="ContentAPI_Navogation.png" width="2706" height="1344" data-path="images/partner_21979592722196.png" />

2. Add your Yotpo API to the endpoint URL. Depending on your use case, the endpoint will change.

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19269568444180.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=62fbf12ac51ecfe1dfdd9c598f743fd7" alt="" width="2872" height="1558" data-path="images/partner_19269568444180.png" />

3. Click on "Save" and then "Done" once you see a successful response.
4. Note - You can also test your APIs. To test your APIs, from the Content API's action menu, click on "Test". You can your API response and validate it.

## Display your customers' loyalty points

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290494694676.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=48220f35ffd6fac773d01d4a9f0c2aac" alt="" width="2842" height="1544" data-path="images/partner_19290494694676.png" />

To display your customers' loyalty points, use Yotpo's [Fetch Customer Details API](https://loyaltyapi.yotpo.com/reference/fetch-customer-details).

While setting up your content API, insert the following URL:

`https://loyalty.yotpo.com/api/v2/customers`

Under URL Parameters, add the following:

1. `customer_email`: Type @ to personalize and select the relevant user attribute from MoEngage.

Under Headers, add the following:

1. `x-guid`: The Globally Unique Identifier found in the "Settings" section of your Yotpo loyalty admin. [Know more](https://loyaltyapi.yotpo.com/reference/authentication)
2. `x-api-key`: Your account API key can be found in the "Settings" section of your Yotpo loyalty admin. [Know more](https://loyaltyapi.yotpo.com/reference/authentication)

To use this API in your MoEngage campaigns,

1. On step 2 on your campaign creation, enter @.
2. In the pop up, you can select the Yotpo Bottom Line configured in Step 1.
3. You can use [MoEngage Templating Language](/user-guide/campaigns-and-channels/getting-started/message-personalization/jinja-templating-language) to parse through the API response and use the content in your campaigns.

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290615846676.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=4bff30ebd02da83032acf2f5782695a6" alt="" width="2606" height="1022" data-path="images/partner_19290615846676.png" />

4. You can click on the Preview tab to view your campaign in real-time personalization:

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290773945748.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=110d67003e7bb36eb969ed8cee98fc87" alt="" width="2842" height="1552" data-path="images/partner_19290773945748.png" />

## Display your product's User Generated Content (UGC)

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290182185492.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=83420a0488fc679d8ef170c5f08f9f5e" alt="" width="2842" height="1548" data-path="images/partner_19290182185492.png" />

To display your product's most recent product image uploaded by your customers, use Yotpo's [Product Images API](https://apidocs.yotpo.com/reference/product-images).

While setting up your content API, insert the following URL:

`https://api.yotpo.com/v1/widget/{app_key}/albums/product/{product_id}`

Replace `{app_key}` with your Yotpo reviews API key. You can get your product ID from your Yotpo Dashboard.

To use this API in your MoEngage campaigns,

1. On step 2 on your campaign creation, enter @.
2. In the pop up, you can select the Yotpo Bottom Line configured in Step 1.
3. You can use [MoEngage Templating Language](/user-guide/campaigns-and-channels/getting-started/message-personalization/jinja-templating-language) to parse through the API response and use the content in your campaigns.

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290867667860.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=32e2cf163cf982d9b667de73d832b066" alt="" width="2600" height="1334" data-path="images/partner_19290867667860.png" />

4. You can click on the Preview tab to view your campaign in real-time personalization:

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290395256980.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=18ecefdcd9e833062d7da42ea91751e0" alt="" width="2842" height="1544" data-path="images/partner_19290395256980.png" />

## Display your product's star rating and review count

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19272748625044.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=a709287988b7b8ebc690162aaedbfde9" alt="" width="2872" height="1558" data-path="images/partner_19272748625044.png" />

To display your product's star ratings or review count, use Yotpo's [Retrieve bottom line API](https://apidocs.yotpo.com/reference/get-bottom-line-total-reviews-and-average-score).

While setting up your content API, insert the following URL:

`https://api.yotpo.com/products/{app_key}/{product_id}/bottomline`

Replace `{app_key}` with your Yotpo reviews API key. You can get your product ID from your Yotpo Dashboard.

To use this API in your MoEngage campaigns,

1. On step 2 on your campaign creation, enter @.
2. In the pop up, you can select the Yotpo Bottom Line configured in Step 1.
3. You can use [MoEngage Templating Language](/user-guide/campaigns-and-channels/getting-started/message-personalization/jinja-templating-language) to parse through the API response and use the content in your campaigns.

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19273094162836.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=1ab09a58e971359b83fac5fa17972d7a" alt="" width="1720" height="708" data-path="images/partner_19273094162836.png" />

4. You can click on the Preview tab to view your campaign in real-time personalization:

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19273146581908.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=9eacd0f63f5089a23bc5fd95b76caee3" alt="" width="2856" height="1494" data-path="images/partner_19273146581908.png" />

## Display your product's most recent 5-star review

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19273255557268.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=f1170dd9344da78ad98e7afc1809091f" alt="" width="2856" height="1548" data-path="images/partner_19273255557268.png" />

To display your product's most recent 5 star review, use Yotpo's [Retrieve reviews for a product API](https://apidocs.yotpo.com/reference/retrieve-reviews-for-a-product).

While setting up your content API, insert the following URL:

`https://api.yotpo.com/v1/widget/{app_key}/products/{product_id}/reviews.json?per_page=50&star=5&sort=votes_up`

Replace `{app_key}` with your Yotpo reviews API key. You can get your product ID from your Yotpo Dashboard.

To use this API in your MoEngage campaigns,

1. On step 2 on your campaign creation, enter @.
2. In the pop up, you can select the Yotpo Bottom Line configured in Step 1.
3. You can use [MoEngage Templating Language](/user-guide/campaigns-and-channels/getting-started/message-personalization/jinja-templating-language) to parse through the API response and use the content in your campaigns.

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290134928404.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=cea0a2578ac7691744c3e27012e11f6a" alt="" width="1730" height="968" data-path="images/partner_19290134928404.png" />

4. You can click on the Preview tab to view your campaign in real-time personalization:

<img src="https://mintcdn.com/moengage/y7-xt66tDwKMqCwN/images/partner_19290138815892.png?fit=max&auto=format&n=y7-xt66tDwKMqCwN&q=85&s=a89957ea82bde63b1ea7dd3c3530eb57" alt="" width="2842" height="1548" data-path="images/partner_19290138815892.png" />
