Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/Vocab/Docs/accept.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
(?:C|c)annonical
(?:C|c)onfig
(?:C|c)rypto
(?:D|d)eduplicate
(?:D|d)eduplication
(?:G|g)tag
(?:K|k)laviyo
(?:L|l)odash
(?:L|l)ookback
(?:P|p)ageviews?\b
(?:P|p)endo
Expand All @@ -19,6 +21,7 @@ allowlist
Amberflo
Appboy
Appsflyer
async
Blitzllama
blocklist
boolean
Expand All @@ -38,6 +41,7 @@ Friendbuy
ga
gmail
Gradle
Heatmapping
href
html
http
Expand Down Expand Up @@ -82,6 +86,7 @@ utm
Vero
Vidora
viewability
waitlist
WebKit
Wootric
Zendesk
1 change: 1 addition & 0 deletions src/_includes/content/dev-center-note.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<div class="premonition info"><div class="fa fa-info-circle"></div><div class="content"><p class="header">Developer Center no longer accepts new components.</p><p markdown=1>Segment is redeveloping the Developer Center and will launch a new version when complete. To stay up to date, add your contact information [here](https://airtable.com/shrT3b4C7agUEBKVS){:target="_blank"}.</p></div></div>
44 changes: 19 additions & 25 deletions src/partners/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: Developer Center Overview
---

> note ""
> **NOTE:** Developer Center is currently in _Developer Preview_. If you are interested in joining the Developer Preview, request access [here](https://segment.com/partners/developer-center/). The use is governed by [(1) Segment First Access](https://segment.com/legal/first-access-beta-preview/) and Beta Terms and Conditions and [(2) Segment Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/). By starting or continuing this process, you also agree to the [Segment Platform Partners Agreement](https://segment.com/legal/partnersagreement/).
{% include content/dev-center-note.md %}


## Building on Segment
Expand All @@ -14,15 +13,15 @@ Below is a sample screenshot of a customer's Segment dashboard, showing all thei

![](images/overview.png)

Segment's core feature is our Connections Catalog:
Segment's core feature is the Connections Catalog:

![](images/catalog.gif)

Customers discover your Sources and Destinations using the Connections Catalog and can enable them from there.

The development process is simple:

1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](https://segment.com/docs/connections/spec).
1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](/docs/connections/spec).
2. Follow Segment's security guidance.
3. Request [access to the Segment Developer Center](https://segment.com/partners/developer-center/).
4. Create an App.
Expand All @@ -37,7 +36,7 @@ It's important to understand Segment's [Conceptual Model](/docs/partners/concept

### 2. Follow Segment's security guidance

Security is a priority for us at Segment for both our customers and our partners. Before you start building on the Developer Center, please review our [Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/) and ensure you're following the below guidance:
Security for both customers and partners is a priority at Segment. Before you start building on the Developer Center, review the [Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/) and ensure you're following the below guidance:

- Follow a secure software-development lifecycle, which enables you to create code that is safe for Segment customers and their end users, and that enables you to maintain and raise the security of that code over time
- If you or your code comes into contact with Segment customer- or end-user data for any reason, protect it with commercially reasonable methods throughout its data lifecycle, including creation, handling, transporting, storing and destruction.
Expand All @@ -48,14 +47,12 @@ Security is a priority for us at Segment for both our customers and our partners

During _Developer Preview_, you will need to [request access to Developer Center](https://segment.com/partners/developer-center/). A Segment account is required for this step.

We receive a large volume of requests so we encourage you to include a valid company website and email address, answer all questions with details about integration's use case as well as highlighting specific customer requests to expedite the approval process.
Segment receives a large volume of requests so please include a valid company website and email address, answer all questions with details about integration's use case as well as highlighting specific customer requests to expedite the approval process.

### 4. Create your App

Once approved, you can create your first [App](/docs/partners/conceptual-model/#apps). This represents a tile in the [Segment catalog](https://segment.com/catalog/) irrespective of which [Component](/docs/partners/conceptual-model/#components) type you choose to build so it should reflect your tool's name (eg. Zendesk Chat, Zendesk Sell).
Once approved, you can create your first [App](/docs/partners/conceptual-model/#apps). This represents a tile in the [Segment catalog](https://segment.com/catalog/) irrespective of which [Component](/docs/partners/conceptual-model/#components) type you choose to build so it should reflect your tool's name (for example, Zendesk Chat, Zendesk Sell).

> info ""
> The Developer Center currently only supports new Partner integrations (ie. Currently does not exist on the [Segment catalog](https://segment.com/catalog/)) in _Developer Preview_. If you're an existing Partner looking to build a new Component or make changes to your existing integration, fill in [your details here](https://airtable.com/shrSweuRx5jspwsw7) and we'll contact you once this is made available!

### 5. Build & Test

Expand All @@ -65,16 +62,14 @@ Now you can start building! Depending on your use case you can build a:
- [Plugin](/docs/partners/plugins)
- [Stream](/docs/partners/streams)

> info ""
> The Developer Center currently only supports the [Subscription](/docs/partners/subscriptions) component in _Developer Preview_. If you're looking to build a [Web Plugin](https://airtable.com/shrT3b4C7agUEBKVS) or [Stream](https://airtable.com/shrj3BkHMhdeaPYWt) fill out the respective form and we'll contact you once this is made available!

No matter which Component you decide to build, make it aligns with the [Segment Spec](https://segment.com/docs/connections/spec). This is a critical component in preserving logical continuity between disparate writers and readers of data. If you encourage customers to break the spec, you are breaking the promise of Segment, and is grounds for removal from the catalog.
No matter which Component you decide to build, make it aligns with the [Segment Spec](/docs/connections/spec). This is a critical component in preserving logical continuity between disparate writers and readers of data. If you encourage customers to break the spec, you are breaking the promise of Segment, and is grounds for removal from the catalog.

It's important that we provide a great experience for our mutual customers so we ask that you also conduct thorough testing of your integration using the tooling provided to you through the Developer Center. We also encourage you to use your Segment sandbox in the shoes of a user to polish the experience of implementing and using your integration.
To provide a positive experience for mutual customers, it's important to test integrations with the tooling provided by the Developer Center. You can also use your Segment sandbox to polish the experience your end users will see.

### 6. Document

Finally, make sure you prepare documentation and relevant marketing material for easy discovery and reference. We ask that you provide the following documentation about your integration by making a copy of the below templates:
Finally, make sure you prepare documentation and relevant marketing material for easy discovery and reference. Provide the following documentation about your integration by making a copy of the below templates:

1. Documentation [hosted by Segment](https://segment.com/docs/) for [Subscription / Plugin](https://hackmd.io/t7amLXluS7-39rg7ARZgSA) or [Stream](https://hackmd.io/TV8cZR6tRnKwGtkvSexeag)
2. Documentation for [the Segment catalog](https://segment.com/catalog/) using [this template](https://docs.google.com/document/d/1kKvqYtZeDPnBjvCrtQSuO3BBH70b_CLO13hYrYIOOtA/edit))
Expand All @@ -84,9 +79,9 @@ Finally, make sure you prepare documentation and relevant marketing material for

### 7. Submission

You can submit your Component in the Developer Center for review. We strive to respond to your submission within 2 business days to kickstart the review process.
You can submit your Component in the Developer Center for review. Segment aims to respond to your submission within two business days to kickstart the review process.

Our team will test your integration and review your documentation and marketing material. In order to keep this review feedback loop short, make sure that your integration:
Segment tests your integration and reviews your documentation and marketing material. To keep this review feedback loop short, make sure that your integration:

- Adheres to the [Segment Spec](/docs/connections/spec/)
- Adheres to your published documentation
Expand All @@ -99,33 +94,32 @@ See the [Public Beta Checklist](/docs/partners/checklist) for a detailed checkli

In a nutshell you need:

1. A working integration tested end-to-end. We encourage you to follow your own documentation and run through the experience as one of our mutual customers.
1. A working integration tested end-to-end. Follow your own documentation and run through the experience as a mutual customer.

2. Complete the fields under the _App Info_ tab with your App including both _Basic Info_ and _Launch Info_. This includes:

- **Segment Documentation:** Using these templates ([subscription](https://hackmd.io/t7amLXluS7-39rg7ARZgSA?both=)/[stream](https://hackmd.io/TV8cZR6tRnKwGtkvSexeag), document how our mutual customers can use your integration.
- **Segment Documentation:** Using these templates ([subscription](https://hackmd.io/t7amLXluS7-39rg7ARZgSA?both=)/[stream](https://hackmd.io/TV8cZR6tRnKwGtkvSexeag), document how mutual customers can use your integration.
- **Your Documentation:** Similar to the above but hosted on your own website.
- **Catalog Details:** Details for our [catalog](https://segment.com/catalog) material including screenshots by making a copy of [this template](https://docs.google.com/document/d/1kKvqYtZeDPnBjvCrtQSuO3BBH70b_CLO13hYrYIOOtA/copy).
- **Catalog Details:** Details for the [catalog](https://segment.com/catalog) material including screenshots by making a copy of [this template](https://docs.google.com/document/d/1kKvqYtZeDPnBjvCrtQSuO3BBH70b_CLO13hYrYIOOtA/copy).
- **Integrations / Partners Page:** Add your Segment integration to your integrations or partners page.
- **Blog Post:** Publish a launch blog post about your integration, like [this](https://www.kustomer.com/blog/kustomer-segment-integration/). Make sure you share it on Twitter and LinkedIn too! (If you don't have a blog, an email is okay)

Be sure to use our [brand kit](https://brandfolder.com/segment/press-kit) for logos, and our [UTM guide](https://docs.google.com/document/d/1L0MHYdF2SYaMMiodQCYlZELF7pN0TXiZbD22nnlGhEk/copy) any time you link to a Segment page.
Be sure to use Segment's [brand kit](https://brandfolder.com/segment/press-kit) for logos, and Segment's [UTM guide](https://docs.google.com/document/d/1L0MHYdF2SYaMMiodQCYlZELF7pN0TXiZbD22nnlGhEk/copy) any time you link to a Segment page.

You can contact us at [[email protected]](mailto:[email protected]) once you have all these elements ready for review. Once we approve them, your Destination goes live on Catalog in Public Beta 🎉
You can contact Segment Partner Support at [[email protected]](mailto:[email protected]) once you have all these elements ready for review. Once approved, your Destination goes live on the Catalog in Public Beta.

## Post Launch

Congratulations on launching your integration in Public Beta - welcome aboard! Here are the next steps to move out from Public Beta to Public:

1. Implement the [Enable with Segment OAuth](/docs/partners/enable-with-segment) button - this makes it much easier for our mutual customers to get started with your integration!
2. Onboard at least 3 customers to actively use your integration
1. Implement the [Enable with Segment OAuth](/docs/partners/enable-with-segment) button - this makes it much easier for mutual customers to get started with your integration!
2. Onboard at least three customers to actively use your integration

Bonus points if you join the [Segment Select](/docs/partners/#segment-select) Partner Program!

## Segment Select

Our focus when working with partners is to ensure we are always providing an exceptional experience to our joint customers.

From there, you can start taking advantage of our available partner opportunities by [joining the Segment Select Partner Program](https://segment.com/partners/integration/#module-5-benefits).
You can taking advantage of Segment's available partner opportunities by [joining the Segment Select Partner Program](https://segment.com/partners/integration/#module-5-benefits).

By becoming a Segment Select partner, you have access to sales support, technical training, and personalized co-marketing opportunities. [Learn more about the program details here.](https://assets.ctfassets.net/9u2t3ap6pctb/3NPVQDweiX0l8Z2edugwIr/d09ea71f04913f3189514b7d2df57d36/Segment_Select_Partner_Program_One_Pager.pdf)
13 changes: 6 additions & 7 deletions src/partners/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,20 @@
title: Building a Plugin
---

> info ""
> The Developer Center currently only supports the [Subscription](/docs/partners/subscriptions) component in _Developer Preview_. Include [your information here](https://airtable.com/shrT3b4C7agUEBKVS) and we'll contact you once _Plugins_ are made available!
{% include content/dev-center-note.md %}

SDK Plugins are used to augment traditional Destination and Source components ([Subscriptions](/docs/partners/subscriptions/) and [Streams](/docs/partners/streams/)) by shipping code to the End User's Device. You can use this mechanism to enable customers to dynamically include your libraries or SDKs and to wire up the Segment SDK to invoke them directly when your plugin is enabled. This pattern is most commonly used to build what we call "Device-mode Destinations".
SDK Plugins are used to augment traditional Destination and Source components ([Subscriptions](/docs/partners/subscriptions/) and [Streams](/docs/partners/streams/)) by shipping code to the End User's Device. You can use this mechanism to enable customers to dynamically include your libraries or SDKs and to wire up the Segment SDK to invoke them directly when your plugin is enabled. This pattern is most commonly used to build "Device-mode Destinations".

Segment's Client SDKs (analytics.js, analytics-ios, and analytics-android) serve as "microcosms" of the Segment Customer Data Infrastructure runtime — they enable the dynamic orchestration of event collection, cleaning and validation, transforming, and delivery to collection endpoints right from inside the SDK.

SDK Plugins are an appropriate component for your App if your source or destination requires client-side side effects, such as collecting ambient data in the client (Heatmapping, Error & Performance Monitoring tools), relying on device-native context such as third party cookies (Advertising pixels), or needs to actively modify the Client UI (e.g. A/B testing, Push Notification, In-App Messaging and LiveChat).
SDK Plugins are an appropriate component for your App if your source or destination requires client-side side effects, such as collecting ambient data in the client (Heatmapping, Error & Performance Monitoring tools), relying on device-native context such as third party cookies (Advertising pixels), or needs to actively modify the Client UI (for example, A/B testing, Push Notification, In-App Messaging and LiveChat).


## Getting Started

Review the steps outlined in the [Developer Center Overview](/docs/partners). This document outlines specific details for Step 4 as it relates to building a plugin.
Review the steps outlined in the [Developer Center Overview](/docs/partners). This document outlines specific details for Step Four as it relates to building a plugin.

1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](https://segment.com/docs/connections/spec).
1. Understand Segment's [Conceptual Model](/docs/partners/conceptual-model) and [Spec](/docs/connections/spec).
2. Follow Segment's security guidance.
3. Request [access to the Segment Developer Center](https://segment.com/partners/developer-center/).
4. Create an App.
Expand All @@ -36,7 +35,7 @@ Once you've created an App, you're ready to starting building your Plugin. Refer

* [iOS Plugin Docs](https://github.com/segmentio/analytics-ios/wiki/Writing-Integrations) + [Mixpanel iOS Plugin Example](https://github.com/segment-integrations/analytics-ios-integration-mixpanel)

As with all partner contributions, only those which follow the Segment [Spec](/docs/connections/spec) will be approved. Once you've finished building your plugin, make sure to reference the above wikis to test your plugin locally. Before reviewing, we'll need to see a full suite of cross-device tests.
As with all partner contributions, only those which follow the Segment [Spec](/docs/connections/spec) will be approved. Once you've finished building your plugin, make sure to reference the above wikis to test your plugin locally. Before reviewing, Segment needs to see a full suite of cross-device tests.

## Next Steps

Expand Down
3 changes: 2 additions & 1 deletion src/partners/streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Build a Stream
---

> info ""
> The Developer Center currently only supports the [Subscription](/docs/partners/subscriptions) component in _Developer Preview_. Include [your information here](https://airtable.com/shrj3BkHMhdeaPYWt) and Segment will contact you once _Streams_ are made available!
> The Developer Center is currently not accepting new components. Segment is committed to redeveloping the Developer Center and a new version will be launched in the future. Include [your information here](https://airtable.com/shrj3BkHMhdeaPYWt){:target="_blank"} and we'll contact you once _Streams_ are made available!


Streams enable you to send data to mutual customers from your web services in realtime.

Expand Down
Loading