Yotpo – Referrals
With Yotpo – Referrals modules in Boost.space Integrator, you can watch, create, retrieve, and search reviews and search product reviews.
To get started with Yotpo – Referrals, create an account at yotpo.com.
Connect Yotpo – Referrals to Boost.space Integrator
To connect Yotpo – Referrals app, you need to obtain the App Key and Secret Key from your Yotpo – Referrals account and insert them into your Boost.space Integrator scenario.
-
Log in to your Yotpo-Referrals account.
-
Click Profile Icon > Store Settings. Copy the App key to a safe place.
-
Click Get Secret Key.
-
Enter the code received via email and click Submit.
-
Copy the Secret Key to a safe place.
-
Log in to your Boost.space Integrator account, insert a Yotpo module in your scenario, and click the Add button next to the Connection field.
-
Optional: In the Connection name field, enter a name for the connection.
-
In the App Key and API Secret fields, enter the app key, and secret key copied in steps 2 and 6, respectively, and click Save.
You have successfully established the connection. You can now edit your scenario and add more Yotpo-Referrals modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.
Reviews
You can watch, create, retrieve, and search reviews and search product reviews using the following modules.
Watch Reviews
Triggers when a review has been created or updated.
Webhook name
Enter a name for the webhook.
Connection
Establish a connection to your Yotpo – Referrals account.
Event Name
Select an event you want to watch:
-
Review Create
-
Review Updated
Create a Review
Creates a new review.
Connection
Establish a connection to your Yotpo – Referrals account.
For field descriptions, see the Yotpo – Referrals Reviews API reference.
Get a Review
Retrieves an existing review.
Connection
Establish a connection to your Yotpo – Referrals account.
Review ID
Select or map the Review ID whose details you want to retrieve.
Search Reviews
Searches for reviews or lists them all.
Connection
Establish a connection to your Yotpo – Referrals account.
Since ID
Enter the lowest ID of the returned reviews.
Since Date
Enter the earliest creation date of returned reviews, for example, 2016-12-27T14:43:58.000Z.
Since Updated at
Enter the earliest updated date of returned reviews, for example, 2017-04-13T18:56:19.000Z.
Deleted
Select whether to include unpublished reviews.
User Reference
Enter a user reference to filter the reviews.
Limit
Set the maximum number of reviews Boost.space Integrator will return during one execution cycle. The default value is 2.
Search Product Reviews
Search for product reviews or lists them all.
Connection
Establish a connection to your Yotpo – Referrals account.
Product ID
Enter the Product ID whose reviews you want to search for.
Star
Enter the product’s star rating in the range of 1 to 5.
Sort
Select an option to sort the search results. For example, date.
Direction
Select the sorting direction. For example, Asc.
Limit
Set the maximum number of product reviews Boost.space Integrator will return during one execution cycle. The default value is 10.
Other
Make an API Call
Performs an arbitrary authorized API call.
For the list of available endpoints, refer to the Yotpo – Referrals API Documentation.
Connection
Establish a connection to your Yotpo – Referrals account.
URL
Enter a path relative to https://api.yotpo.com. For example, /v1/apps/8tztCoWR6GJaIkGwxLYvvsitHhsTj78jxdZ4kw1X/reviews.
Method
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of use – List Reviews
The following API call returns reviews from your account.
URL: /v1/apps/{app_key}/reviews.
Method: GET
Matches of the search can be found in the module’s Output under Bundle > Body > reviews.
Our example returned 4 reviews:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/marketing/yotpo-referrals/).
