Skip to content

Commit eafb62c

Browse files
peterikladiouspeterikladious
committed
Create index.md
1 parent 526f24f commit eafb62c

File tree

1 file changed

+151
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/unlocking-attribution

1 file changed

+151
-0
lines changed

‎src/connections/sources/catalog/cloud-apps/unlocking-attribution/index.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# 💥 Segment Partner Source Documentation Template
2+
3+
> Hi Partners 👋🏼
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.
6+
>
7+
> Here are the guidelines we want you to have in mind when writing out your documentation:
8+
>
9+
> - Be succinct and simple in your writing. Reduce text bloat where possible.
10+
> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
11+
> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
12+
>
13+
> - Screenshots/Images are generally discouraged unless absolutely necessary
14+
>
15+
> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps:
16+
>
17+
> 1. Fork and clone the `segment-docs` repo locally
18+
> 2. Create a new branch (e.g., partner-name/source)
19+
> 3. Create an `index.md` file in the following path `src/connections/sources/catalog/cloud-apps/{source-slug}/index.md
20+
> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates
21+
> 5. Add, commit, and push your code, then submit a pull request to the `segment-docs` repo
22+
>
23+
> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option!
24+
>
25+
> If you have any questions in the meantime, please reach out to our team at [email protected].
26+
27+
## Template begins here...
28+
---
29+
title: [integration_name] Source
30+
---
31+
32+
> (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+
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.
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.
37+
38+
> (delete after reading) Update your company name and support email address.
39+
40+
This source is maintained by <integration_name>. For any issues with the source, [contact their Support team](mailto:support@<integration_name>.com).
41+
42+
> (delete after reading) Update your company name (x2) and support email address.
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)!_
45+
46+
## Getting Started
47+
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+
50+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
51+
2. Search for "<integration_name>" in the Sources Catalog, select <integration_name>, and click **Add Source**.
52+
3. On the next screen, give the Source a nickname configure any other settings.
53+
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+
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.
58+
59+
## Stream
60+
61+
> (delete after reading) Clarify the type of Segment events your integration will send.
62+
63+
<integration_name> uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
64+
65+
> (delete after reading) Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo:
66+
67+
The default behavior is for Klaviyo to pass the userId associated with the email recipient as the userId. There are cases in which Klaviyo does not have an associated userId, in which case the email address will be passed in as the anonymousId.
68+
69+
> (delete after reading) For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source.
70+
71+
## Events
72+
73+
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.
74+
75+
<table>
76+
<tr>
77+
<td>Event Name</td>
78+
<td>Description</td>
79+
</tr>
80+
<tr>
81+
<td>Email Sent</td>
82+
<td>Email was sent successfully</td>
83+
</tr>
84+
<tr>
85+
<td>Email Opened</td>
86+
<td>Prospect opened the email</td>
87+
</tr>
88+
<tr>
89+
<td>Link Clicked</td>
90+
<td>Prospect clicked the tracking link</td>
91+
</tr>
92+
<tr>
93+
<td>Email Replied</td>
94+
<td>Prospect replied to the email sent</td>
95+
</tr>
96+
<tr>
97+
<td>Email Bounced</td>
98+
<td>Email servers rejected the email</td>
99+
</tr>
100+
<tr>
101+
<td>Email Unsubscribed</td>
102+
<td>Prospect clicked the unsubscribe link</td>
103+
</tr>
104+
</table>
105+
106+
## Event Properties
107+
108+
The table below list the properties included in the events listed above.
109+
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>
140+
141+
## Adding Destinations
142+
143+
Now that your Source is set up, you can connect it with Destinations.
144+
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.
146+
147+
If there are any issues with how the events are arriving to Segment, [contact the <integration_name> support team](mailto:support@<integration_name>.com).
148+
149+
---
150+
151+
> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.

0 commit comments

Comments
 (0)