HackMD
  • Power Up!
    Power Up!  Browser extension
    Instantly search and open your HackMD note from your browser.
    Learn more Got it
    • Create new note
    • Create a note from template
  • Power Up!  Browser extension
    Power Up!  Browser extension
    Instantly search and open your HackMD note from your browser.
    Learn more Got it
    • Options
    • Versions
    • Transfer ownership
    • Delete this note
    • Template
    • Save as template
    • Insert from template
    • Export
    • Dropbox
    • Google Drive
    • Gist
    • Import
    • Dropbox
    • Google Drive
    • Gist
    • Clipboard
    • Download
    • Markdown
    • HTML
    • Raw HTML
    • ODF (Beta)
    • Sharing Link copied
    • /edit
    • View mode
      • Edit mode
      • View mode
      • Book mode
      • Slide mode
      Edit mode View mode Book mode Slide mode
    • Note Permission
    • Read
      Owners
      • Owners
      • Signed-in users
      • Everyone
      Owners Signed-in users Everyone
    • Write
      Owners
      • Owners
      • Signed-in users
      • Everyone
      Owners Signed-in users Everyone
    • More (Comment, Invitee)
    • Publishing

      After the note is published, everyone on the web can find and read this note.
      See all published notes on profile page.

    • More (Comment, Invitee)
    • Commenting Enable
      Disabled Forbidden Owners Signed-in users Everyone
    • Permission
      Owners
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Invitee
    • No invitee
Menu Sharing Create Help
Create Create new note Create a note from template
Menu
Options
Versions Transfer ownership Delete this note
Export
Dropbox Google Drive Gist
Import
Dropbox Google Drive Gist Clipboard
Download
Markdown HTML Raw HTML ODF (Beta)
Back
Sharing
Sharing Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Note Permission
Read
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
Write
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
More (Comment, Invitee)
Publishing

After the note is published, everyone on the web can find and read this note.
See all published notes on profile page.

More (Comment, Invitee)
Commenting Enable
Disabled Forbidden Owners Signed-in users Everyone
Permission
Owners
  • Forbidden
  • Owners
  • Signed-in users
  • Everyone
Invitee
No invitee
   Published      
   owned this note    owned this note
   Linked with GitHub
  • Watch - Be notified of any changes
  • Never - Never be notified
# 💫 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). >+ 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, please 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, please 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/destinations/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. --- ## 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, please [reach out to their team](mailto:support@YOURINTEGRATION.com). > Update your company name (x2) and support email address. _**NOTE:** The YOURINTEGRATION Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on January 23, 2019. If you are interested in joining their beta program or have any feedback to help improve the YOURINTEGRATION Destination and its documentation, please [let their team know](mailto:support@YOURINTEGRATION.com)!_ ## Getting Started > Do not remove this line. It will auto-populate the following information for your integration: https://cl.ly/23e637f055f7 {{>connection-modes}} > 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 your Segment UI's Destinations page click on "Add Destination". 2. Search for "YOURINTEGRATION" within the Destinations Catalog and confirm the Source you'd like to connect to. 3. Drop in the "API Key" into your Segment Settings UI which you can find from your [YOURINTEGRATION dashboard](https://YOURINTEGRATION.com/dashboard). > 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. ## Page If you haven't had a chance to review our spec, please take a look to understand what the [Page method](https://segment.com/docs/spec/page/) does. An example call would look like: ``` analytics.page() ``` Page calls will be sent to YOURINTEGRATION as a `pageview`. ## Screen If you haven't had a chance to review our spec, please take a look to understand what the [Screen method](https://segment.com/docs/spec/screen/) does. An example call would look like: ``` [[SEGAnalytics sharedAnalytics] screen:@"Home"]; ``` Screen calls will be sent to YOURINTEGRATION as a `screenview`. ## Identify If you haven't had a chance to review our spec, please take a look to understand what the [Identify method](https://segment.com/docs/spec/identify/) does. An example call would look like: ``` analytics.identify('userId123', { email: 'john.doe@segment.com' }); ``` Identify calls will be sent to YOURINTEGRATION as an `identify` event. ## Track If you haven't had a chance to review our spec, please take a look to understand what the [Track method](https://segment.com/docs/spec/track/) does. An example call would look like: ``` analytics.track('Clicked Login Button') ``` Track calls will be sent 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!

Import from clipboard

Editing is for members only

With current role, you can only comment.
Learn how

This team is disabled

Sorry, this team is disabled. You can't edit this note.

This note is locked

Sorry, only owner can edit this note.

Reach the limit

Sorry, you've reached the max length this note can be.
Please reduce the content or divide it to more notes, thank you!

Import from Gist

Import from Snippet

or

Export to Snippet

Are you sure?

Do you really want to delete this note?
All users will lost their connection.

Transfer ownership

    or

      Create a note from template

      Create a note from template

      Oops...
      This template is not available.
      All
      • All
      • Team
      No template found.

      Create a template

      Delete template

      Do you really want to delete this template?

      This page need refresh

      You have an incompatible client version.
      Refresh to update.
      New version available!
      See releases notes here
      Refresh to enjoy new features.
      Your user state has changed.
      Refresh to load new user state.
      Buy us coffee

      Sign in

      Forgot password

      or

      By clicking below, you agree to our terms of service.

      Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in via Google

      New to HackMD? Sign up

      Help

      Contacts

      Talk to us
      Report an issue
      Send us email
      Buy us coffee

      Documents

      Features
      YAML Metadata
      Slide Example
      Book Example

      Cheatsheet

      Example
      Header # Header
      • Unordered List
      - Unordered List
      1. Ordered List
      1. Ordered List
      • Todo List
      - [ ] Todo List
      Blockquote
      > Blockquote
      Bold font **Bold font**
      Italics font *Italics font*
      Strikethrough ~~Strikethrough~~
      19th 19^th^
      H2O H~2~O
      Inserted text ++Inserted text++
      Marked text ==Marked text==
      Link [link text](https:// "title")
      Image ![image alt](https:// "title")
      Code `Code`
      var i = 0;
      ```javascript
      var i = 0;
      ```
      :smile: :smile:
      Externals {%youtube youtube_id %}
      LaTeX $L^aT_eX$

      This is a alert area.

      :::info
      This is a alert area.
      :::

      Versions

      Versions

      Sign in to link this note to GitHub Learn more
      This note is not linked with GitHub Learn more
       

      Version named by    

      More Less
      • Edit
      • Delete

      Note content is identical to the latest version.
      Compare with
        Choose a version
        No search result
        Version not found

      Feedback

      Submission failed, please try again

      Thanks for your support.

      On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

      Please give us some advice and help us improve HackMD.

       

      Thanks for your feedback

      Remove version name

      Do you want to remove this version name and description?

      Link with GitHub

      Please authorize HackMD on GitHub

      Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

       Sign in to GitHub

      HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

      Push the note to GitHub Push to GitHub Pull a file from GitHub

       Authorize again
       

      Choose which file to push to

      Select repo
      Refresh Authorize more repos
      Select branch
      Select file
      Select branch
      Choose version(s) to push
      • Save a new version and push
      • Choose from existing versions

      Pull from GitHub

       
      File from GitHub
      File from HackMD

      GitHub Link Settings

      File linked

      Linked by
      File path
      Last synced branch

      Danger Zone

      Unlink
      You will no longer receive notification when GitHub file changes after unlink.

      Syncing

      Push failed

      Push successfully