Important product naming update: Sidekick is now called Gladly (AI) and Gladly Hero (the Platform) is now Gladly Team. Please keep this in mind as you read through our documentation.

Yotpo on App Platform Installation

Prev Next

The Yotpo app is set up from Gladly’s Settings. You will need your Yotpo App Key, explained below.

Before you start: get your Yotpo App Key

In Yotpo, open Account Settings > General Settings. Your App Key is at the bottom of the General Settings section. See Finding your Yotpo app key and secret key.

Step 1: Open the Apps settings

In Gladly, go to Settings > App Developer Tools > Apps. This is where you manage your App Platform integrations.

Step 2: Create a configuration

On the App Platform tab, click the Create Configuration button. Enter a unique Configuration Name, such as “Yotpo Production.” When prompted for the External App, choose the Yotpo app (gladly.com/yotpo), picking the latest version available.

Step 3: Enter your Yotpo App Key

Paste the App Key from Yotpo into the App Key field.

Step 4: Set the review limit (optional)

Review Limit is the number of reviews the app fetches from Yotpo for each customer, from 1 to 50. If it is left blank, 10 are fetched.

Step 5: Set the loyalty action limits (optional)

These settings control the Adjust points and Record campaign action forms, and the same actions when used by Gladly AI. Existing configurations keep working without them.

  • Maximum points adjustment: the largest number of points one adjustment, or one campaign points override, can add or remove. Default 1000. Enter 0 to turn points adjustments off.

  • Allow negative adjustments: lets team members remove points as well as add them. Off by default.

  • Default history title: the line shown in the customer’s points history when an adjustment leaves the title blank. Default “Courtesy points from customer support.”

  • Campaign action names: the action names of your Custom Action campaigns in Yotpo Loyalty, separated by commas and spelled exactly as in Yotpo, for example gladly_survey_completed, accepted_exchange. Team members then pick the campaign from a list. If it is left blank, they type the name, and Yotpo refuses a name that does not match a campaign.

Step 6: Add the Yotpo cards to the Customer Profile

Save the configuration, then add each card in Settings > Agent Experience > Customer Profile: hover between two existing cards until the green + appears, select it, choose App Platform Card, then pick your Yotpo configuration, the card template and its query. Full directions: Organize the Customer Profile.

  • Loyalty & Referrals: card template “Display Yotpo customer profile data,” query customers.

  • Reviews: card template “Displays reviews for which the email matches that of Gladly customer,” query reviews.

Each card also has an optional Limits setting that caps how many results it shows. Select Add limit, then enter a query path and a number. The paths that apply to the Yotpo cards are:

  • customers (Loyalty & Referrals card): the number of Yotpo customer profiles shown when more than one matches the Gladly customer. Enter 1 to show a single profile.

  • reviews (Reviews card): the number of reviews shown. The app never fetches more than the Review limit from Step 4 (default 10, maximum 50), so a card limit above that has no effect.

  • reviews.custom_fields (Reviews card): the number of custom question answers shown for each review.

  • reviews.images_data (Reviews card): the number of photos shown for each review. The card shows at most three, so only 1 or 2 changes anything.

Leave Limits empty to show everything the app returns.

Step 7: Add the agent actions

Installing the app does not put the three forms (Adjust points, Record campaign action, Reply to review) in the compose menu. Add them in Settings > Agent Experience > Agent Actions, one at a time: give each a Label, choose your Yotpo configuration under App / Configuration, choose the Action, select Add, then Save the page. The Yotpo configuration must be saved and active first, since an Agent Action can only reference an active App Configuration. Full directions: Set up Agent Actions.

To let Gladly AI use the actions, add them in the Gladly AI settings.

Contact Support

Users assigned the Team Manager or Administrator roles can contact Gladly Support. Log into Gladly as one of these roles, click the hamburger menu on the top-left corner, then click Contact Gladly Support. Gladly Support’s primary operating hours are Monday through Friday, 6 AM to 6 PM Pacific Time, but you can submit a request anytime.

  • Please select the correct business impact (P1 to P4).

  • Most requests should be sent as a P4.