owned this note
owned this note
Published
Linked with GitHub
# 💫 Segment Partner Destination Documentation Template
> Hi Partners 👋🏼
>
> 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.
>
> At Segment, we believe that documentation is crucial in delivering the best experience for our mutual customers so we want to think with the following mindset:
>
>+ Be succinct and simple in your writing. Reduce text bloat where possible.
>+ Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
>+ Use the active voice - instead of "The destination will do this." write something like "The destination does this."
>+ Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
>
>+ Provide actionable code samples for each API method.
>
>+ If you would like to include screenshots, send the original image to us via partner-support@segment.com with naming corresponding to where you've included it within the Markdown below. We prefer PNG images within 400px - 1200px. If you'd like to submit a GIF, keep under 15MB. Generally you should be able to write these out as text, so only use them when there's something really hard to explain.
>
> The below template intends to provide a standardized structure. Please **make a copy** of this template for editing and submit to the Segment team as a new note on [HackMD.io](https://hackmd.io/). You can view a sample doc as reference here: https://segment.com/docs/connections/destinations/catalog/clearbrain/.
>
> 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!
>
> If you have any questions in the meantime, please reach out to our team at partner-support@segment.com.
---
title: [integration_name] Destination
---
## Template begins here...
> 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.
[YOURINTEGRATION](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.
> Update your company name and support email address.
This destination is maintained by YOURINTEGRATION. For any issues with the destination, [contact the YOURINTEGRATION Support team](mailto:support@YOURINTEGRATION.com).
> Update your company name (x2) and support email address.
## Getting Started
> Do not remove this line. It will auto-populate the following information for your integration:
{% include content/connection-modes.md %}
> Include clear, succinct steps including hyperlinks to where customers can locate their API Key in your app. If there is an expected delay for a customer to see data flow into your integration, please make that explicit.
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for "YOURINTEGRATION" in the Destinations Catalog, and select the "YOURINTEGRATION" destination.
3. Choose which Source should send data to the "YOURINTEGRATION" destination.
4. Go to the [YOURINTEGRATION dashboard](https://YOURINTEGRATION.com/dashboard){:target="_blank"}, find and copy the "API key".
5. Enter the "API Key" in the "YOURINTEGRATION" destination settings in Segment.
> For each of the following call types (Page, Screen, Identify, Track, Group), update:
> 1. Code snippet with relevant code sample including required traits or properties.
> 2. Your integration name.
> 3. What the corresponding call looks like within your platform (eg. Segment `page` call might be a `pageview` on your platform).
> 4. It can be helpful to describe *where* data will appear (ie. Will `identify` calls appear within a Users dashboard as well as the Real-time dashboard of your platform?)
> 5. Any other important information for customer to note when sending through the events.
## Supported methods
YOURINTEGRATION supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
### Page
Send [Page](/docs/connections/spec/page) calls to *ADD WHAT PAGE CALLS ARE USED FOR HERE*. For example:
```js
analytics.page()
```
Segment sends Page calls to YOURINTEGRATION as a `pageview`.
### Screen
Send [Screen](/docs/connections/spec/screen) calls to *ADD WHAT SCREEN CALLS ARE USED FOR HERE*. For example:
```obj-c
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
```
Segment sends Screen calls to YOURINTEGRATION as a `screenview`.
### Identify
Send [Identify](/docs/connections/spec/identify) calls to *ADD WHAT IDENTIFY CALLS ARE USED FOR HERE*. For example:
```js
analytics.identify('userId123', {
email: 'john.doe@example.com'
});
```
Segment sends Identify calls to YOURINTEGRATION as an `identify` event.
### Track
Send [Track](/docs/connections/spec/track) calls to *ADD WHAT Track CALLS ARE USED FOR HERE*. For example:
```js
analytics.track('Login Button Clicked')
```
Segment sends Track calls to YOURINTEGRATION as a `track` event.
---
> 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 via your designated Slack Channel and we’ll respond with updates when we publish it and your integration!
