Skip to content

Commit 363cdd9

Browse files
Merge pull request #6665 from YotpoLtd/yotpo/source
add yotpo as a source docs
2 parents 914a63f + 3634da6 commit 363cdd9

File tree

1 file changed

+61
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/yotpo

1 file changed

+61
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Yotpo Source
3+
beta: true
4+
id: q4JbVJwmrg
5+
---
6+
7+
[Yotpo](https://yotpo.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a retention marketing platform that helps turn one-time shoppers into customers for life and maximize customer value. It enables you to collect and showcase customer reviews, offer loyalty programs and SMS and email marketing solutions.
8+
9+
Take your company’s customer engagement to the next level by adding Yotpo as a Source to Segment. Segment automatically collects engagement events (like SMS sent, SMS clicked, and Email opened), forwards them to your destinations, and loads them into your data warehouse.
10+
11+
## Getting started
12+
13+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add source**.
14+
2. Search for **Yotpo** in the Sources Catalog, select Yotpo, and click **Add Source**.
15+
2. On the next screen, give the Source a name. You can also apply labels to the source and connect the source to your warehouses. When you've finished setting up your source, click **Add Source**.
16+
3. Segment redirects you to the Overview page and surfaces your Segment write key for Yotpo. Copy this write key.
17+
4. In your Yotpo integration center, search for "Segment" and click **Connect**.
18+
5. On the Provide API Key stage of the integration process, enter the **Segment Write Key**.
19+
6. Click **Connect**.
20+
7. Return to Segment and click **Add Destinations** in your Yotpo source to add the destinations where you want to send your SMS and email events.
21+
22+
## Events
23+
24+
The table below lists events that Yotpo sends to Segment. These events appear as tables in your warehouse, and as regular events in other destinations. Yotpo includes the user identifier you have associated with the user as the Segment `userId` if available. Additionally, Yotpo will utilize the phone number or email address as the Segment `anonymousId`, depending on the type of event (email versus SMS).
25+
26+
| Event Name | Description |
27+
|--------------------|----------------------------------------------------------|
28+
| SMS Sent | An SMS was sent. |
29+
| SMS Clicked | User clicked a short link in an SMS message. |
30+
| SMS Unsubscribed | User clicked the unsubscribe link in an SMS. |
31+
| SMS Subscribed | User subscribed to receive SMS messages. |
32+
| Email Sent | An email was sent to the user. |
33+
| Email Delivered | An email was successfully delivered to the user's inbox. |
34+
| Email Opened | User opened an email. |
35+
| Email Clicked | User clicked a link within an email. |
36+
| Email Bounced | An email could not be delivered to the user. |
37+
| Email Unsubscribed | User clicked the unsubscribe link in an email. |
38+
| Email Subscribed | User subscribed to receive emails. |
39+
40+
## Event Properties
41+
42+
The table below list the properties included in the events listed above.
43+
44+
| Property Name | Description |
45+
|----------------------|--------------------------------------------------|
46+
| `source_name` | The name of the source that generated the event. |
47+
| `sub_source` | A secondary identifier for the event source. |
48+
| `source_id` | A unique identifier for the event source. |
49+
| `email_reference_id` | A unique ID to reference a specific email. |
50+
| `clicked_url` | The URL that was clicked in the event. |
51+
| `store_id` | A unique identifier for the Yotpo store. |
52+
| `flow_id` | A unique identifier for the Yotpo flow. |
53+
| `campaign_id` | A unique identifier for the Yotpo campaign. |
54+
55+
## Adding Destinations
56+
57+
Now that your source is set up, you can connect it to destinations.
58+
59+
Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the docs for each destination for troubleshooting.
60+
61+
If there are any issues with how the events are arriving to Segment, [contact the Yotpo support team]([email protected]).

0 commit comments

Comments
 (0)