Developer Center Overview
NOTE: Developer Center is currently in Developer Preview. If you are interested in joining the Developer Preview, request access here. The use is governed by (1) Segment First Access and Beta Terms and Conditions and (2) Segment Acceptable Use Policy. By starting or continuing this process, you also agree to the Segment Platform Partners Agreement.
Building on Segment
Over 19,000 companies use Segment as their central hub for collecting and synthesizing first-party customer data. Customers use Segment Sources to collect data across all their properties (web, mobile, CRMs, email etc.) and send this data into Destinations (SaaS tools, internal databases or queues, or a data warehouse) to perform analytics, run marketing campaigns and much more.
Below is a sample screenshot of a customer’s Segment dashboard, showing all their sources of data on the left, and destinations for their data on the right.
Segment’s core feature is our Connections Catalog:
Customers discover your Sources and Destinations using the Connections Catalog and can enable them from there.
The development process is simple:
- Understand Segment’s Conceptual Model and Spec.
- Follow Segment’s security guidance.
- Request access to the Segment Developer Center.
- Create an App.
- Build and test your Component(s).
- Publish documentation.
- Submit your App for review.
- Launch into Public Beta!
1. Understand Segment’s Conceptual Model
It’s important to understand Segment’s Conceptual Model to begin planning your integration. This will help you understand how data will flow from or into your integration.
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 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.
- If you suspect a security event, incident or breach while working on this project or afterward, contact Segment Security for assistance with your investigation and communications
- Practice modern and common-sense security for any scenario not explicitly stated
3. Request Access
During Developer Preview, you will need to request access to 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.
4. Create your App
Once approved, you can create your first App. This represents a tile in the Segment catalog irrespective of which Component type you choose to build so it should reflect your tool’s name (eg. Zendesk Chat, Zendesk Sell).
The Developer Center currently only supports new Partner integrations (ie. Currently does not exist on the Segment 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 and we’ll contact you once this is made available!
5. Build & Test
Now you can start building! Depending on your use case you can build a:
No matter which Component you decide to build, make it aligns with the Segment 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.
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:
- Documentation hosted by Segment for Subscription / Plugin or Stream
- Documentation for the Segment catalog using this template)
- Documentation hosted on your own website about your new Segment integration
- Draft blog post announcing your new integration
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.
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:
- Adheres to the Segment Spec
- Adheres to your published documentation
- Supports high data volumes
- Meets all launch requirements
See the Public Beta Checklist for a detailed checklist used by the Segment team to review and approve the launch of your integration.
In a nutshell you need:
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.
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/stream, document how our mutual customers can use your integration.
- Your Documentation: Similar to the above but hosted on your own website.
- Catalog Details: Details for our catalog material including screenshots by making a copy of this template.
- Integrations / Partners Page: Add your Segment integration to your integrations or partners page, like this.
- Blog Post: Publish a launch blog post about your integration, like this. Make sure you share it on Twitter and LinkedIn too! (If you don’t have a blog, an email is okay)
You can contact us at email@example.com once you have all these elements ready for review. Once we approve them, your Destination goes live on Catalog in Public Beta 🎉
Congratulations on launching your integration in Public Beta - welcome aboard! Here are the next steps to move out from Public Beta to Public:
- Implement the Enable with Segment OAuth button - this makes it much easier for our mutual customers to get started with your integration!
- Onboard at least 3 customers to actively use your integration
Bonus points if you join the Segment Select Partner Program!
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.
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.
This page was last modified: 09 Sep 2020
Questions? Problems? Need more info? Contact us, and we can help!