Yotpo
This page contains the setup guide and reference information for the Yotpo source connector.
Prerequisites
To set up the Yotpo source connector, you need:
- A Yotpo account with API access
- Your Yotpo App Key (found in your Yotpo account settings)
- An Access Token generated from the Yotpo API
Setup guide
Step 1: Generate an Access Token
- You need your App Key and API Secret to generate an access token
- Find your App Key and API Secret in your Yotpo account settings
- Generate an access token using the Yotpo authentication endpoint:
with the following parameters:
POST https://api.yotpo.com/oauth/token{
"client_id": "YOUR_APP_KEY",
"client_secret": "YOUR_API_SECRET",
"grant_type": "client_credentials"
} - Store the returned access token securely as it will be used for all API calls
Step 2: Set up the Yotpo connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account
- In the left navigation bar, click Sources. In the top-right corner, click New Source
- On the Set up the source page, enter the name for the Yotpo connector and select Yotpo from the Source type dropdown
- Enter the following required parameters:
access_token: The access token generated in Step 1app_key: Your Yotpo App Keystart_date: The date from which you want to start syncing data (format: YYYY-MM-DDT00:00:00.000Z)email: Your registered email address with Yotpo
- Click Set up source
For Airbyte OSS:
- Navigate to the Airbyte Open Source dashboard
- Set the name for your source
- Enter the required parameters as described above
- Click Set up source
Supported sync modes
The Yotpo source connector supports the following sync modes:
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental Sync | Yes |
| Replicate Incremental Deletes | No |
| SSL connection | Yes |
| Namespaces | No |
Supported Streams
| Stream Name | Description | Incremental | Notes |
|---|---|---|---|
| email_analytics | Retrieves aggregated data for email metrics | No | Data is grouped by metrics and can be filtered by date range |
| raw_data | Returns detailed data about every email sent from Yotpo | No | Includes email recipient, delivery status, open/click events |
| reviews | Retrieves product reviews | Yes | Uses created_at as cursor field with a lookback window of 31 days |
| unsubscribers | Lists users who have unsubscribed from emails | No | Limited to 5000 responses per request, requires pagination for larger datasets |
| webhooks | Lists all webhooks created for the account | No | Includes webhook URL and event type information |
| webhook_events | Lists available webhook event types | No | Includes event names and descriptions |
Performance considerations
Rate Limits
- The Reviews endpoint is limited to 5,000 requests per minute per app key
- For Reviews, it's recommended to query up to 100 reviews per request (default is 10)
- Review data is retrieved with a delay of 1 hour
Pagination
- For the Reviews stream, pagination is handled automatically using page and count parameters
- For the Unsubscribers stream, if your list exceeds 5000 email addresses, you must use the count and page parameters for pagination
API method example
GET https://api.yotpo.com/v1/apps/{app_key}/reviews?utoken={access_token}
IP allow list
If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.
Reference
Config fields reference
Field
Type
Property name
string
access_token
string
app_key
string
email
string
start_date
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.2.16 | 2025-10-21 | 68442 | Update dependencies |
| 0.2.15 | 2025-10-14 | 68011 | Update dependencies |
| 0.2.14 | 2025-10-07 | 67250 | Update dependencies |
| 0.2.13 | 2025-09-30 | 66843 | Update dependencies |
| 0.2.12 | 2025-09-24 | 66469 | Update dependencies |
| 0.2.11 | 2025-09-09 | 65710 | Update dependencies |
| 0.2.10 | 2025-08-24 | 65429 | Update dependencies |
| 0.2.9 | 2025-08-10 | 64819 | Update dependencies |
| 0.2.8 | 2025-08-02 | 64357 | Update dependencies |
| 0.2.7 | 2025-07-26 | 64066 | Update dependencies |
| 0.2.6 | 2025-07-19 | 63622 | Update dependencies |
| 0.2.5 | 2025-07-12 | 63210 | Update dependencies |
| 0.2.4 | 2025-07-05 | 62684 | Update dependencies |
| 0.2.3 | 2025-06-28 | 62250 | Update dependencies |
| 0.2.2 | 2025-06-21 | 61748 | Update dependencies |
| 0.2.1 | 2025-06-15 | 47597 | Update dependencies |
| 0.2.0 | 2024-08-26 | 44780 | Refactor connector to manifest-only format |
| 0.1.14 | 2024-08-24 | 44661 | Update dependencies |
| 0.1.13 | 2024-08-17 | 44254 | Update dependencies |
| 0.1.12 | 2024-08-12 | 43891 | Update dependencies |
| 0.1.11 | 2024-08-10 | 43658 | Update dependencies |
| 0.1.10 | 2024-08-03 | 43198 | Update dependencies |
| 0.1.9 | 2024-07-27 | 42610 | Update dependencies |
| 0.1.8 | 2024-07-20 | 42275 | Update dependencies |
| 0.1.7 | 2024-07-13 | 41815 | Update dependencies |
| 0.1.6 | 2024-07-10 | 41444 | Update dependencies |
| 0.1.5 | 2024-07-09 | 41250 | Update dependencies |
| 0.1.4 | 2024-07-06 | 40795 | Update dependencies |
| 0.1.3 | 2024-06-25 | 40488 | Update dependencies |
| 0.1.2 | 2024-06-21 | 39945 | Update dependencies |
| 0.1.1 | 2024-05-20 | 38390 | [autopull] base image + poetry + up_to_date |
| 0.1.0 | 2023-04-14 | Init | Initial commit |