You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: templates/partners/source.md
+27-68Lines changed: 27 additions & 68 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
> Hi Partners 👋🏼
4
4
>
5
-
> Welcome to Segment - glad to have you onboard! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
5
+
> Welcome to Segment - glad to have you on board! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
6
6
>
7
7
> Here are the guidelines we want you to have in mind when writing out your documentation:
> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.
33
33
34
-
[<integration_name>](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
34
+
[<integration_name>](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
35
35
36
-
This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations.
36
+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
37
37
38
38
> (delete after reading) Update your company name and support email address.
39
39
40
40
This source is maintained by <integration_name>. For any issues with the source, [contact their Support team](mailto:support@<integration_name>.com).
41
41
42
42
> (delete after reading) Update your company name (x2) and support email address.
43
43
44
-
_**NOTE:** The <integration_name> Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on <Month_Name DD, YYYY>. If you are interested in joining their beta program or have any feedback to help improve the <integration_name> Source and its documentation, [let their team know](mailto:support@<integration_name>.com)!_
44
+
_**NOTE:** The <integration_name> Source is currently in beta, which means that they are still actively developing the source. If you are interested in joining their beta program or have any feedback to help improve the <integration_name> Source and its documentation, [let the <integration_name> team know](mailto:support@<integration_name>.com)._
45
45
46
-
## Getting Started
46
+
## Getting started
47
47
48
48
> (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey.
49
49
50
-
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
50
+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
51
51
2. Search for "<integration_name>" in the Sources Catalog, select <integration_name>, and click **Add Source**.
52
52
3. On the next screen, give the Source a nickname configure any other settings.
53
53
54
54
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).
55
55
56
56
4. Click **Add Source** to save your settings.
57
-
5. Copy the Write key from the Segment UI and log in to your <integration_name> account - navigate to Settings > Integrations > Segment Integration and paste the key to connect.
57
+
5. Copy the Write key from the Segment UI.
58
+
6. Log in to your <integration_name> account - navigate to Settings > Integrations > Segment Integration and paste the key to connect.
58
59
59
60
## Stream
60
61
@@ -72,77 +73,35 @@ The default behavior is for Klaviyo to pass the userId associated with the email
72
73
73
74
The table below lists events that <integration_name> sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. <integration_name> includes the `userId` if available.
| Link Clicked | Prospect clicked the tracking link |
81
+
| Email Replied | Prospect replied to email sent |
82
+
| Email Bounced | Email servers rejected the email |
83
+
| Email Unsubscribed | Prospect clicked the unsubscribe link |
84
+
105
85
106
86
## Event Properties
107
87
108
88
The table below list the properties included in the events listed above.
109
89
110
-
<table>
111
-
<tr>
112
-
<td>Property Name</td>
113
-
<td>Description</td>
114
-
</tr>
115
-
<tr>
116
-
<td>`event`</td>
117
-
<td>Email event type</td>
118
-
</tr>
119
-
<tr>
120
-
<td>`userId`</td>
121
-
<td>Prospect email ID</td>
122
-
</tr>
123
-
<tr>
124
-
<td>`email_id`</td>
125
-
<td>ID of the email</td>
126
-
</tr>
127
-
<tr>
128
-
<td>`fromId`</td>
129
-
<td>Sender email ID</td>
130
-
</tr>
131
-
<tr>
132
-
<td>`email_subject`</td>
133
-
<td>Subject line of the email</td>
134
-
</tr>
135
-
<tr>
136
-
<td>`link`</td>
137
-
<td>URL of the link clicked</td>
138
-
</tr>
139
-
</table>
90
+
| Property Name | Description |
91
+
| --------------- | ------------------------- |
92
+
|`event`| Email event type |
93
+
|`userId`| Prospect user ID |
94
+
|`email_id`| ID of the email |
95
+
|`fromId`| Sender email ID |
96
+
|`email_subject`| Subject line of the email |
97
+
|`link`| URL of the link clicked |
98
+
140
99
141
100
## Adding Destinations
142
101
143
102
Now that your Source is set up, you can connect it with Destinations.
144
103
145
-
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](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
104
+
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](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
146
105
147
106
If there are any issues with how the events are arriving to Segment, [contact the <integration_name> support team](mailto:support@<integration_name>.com).
0 commit comments