Build your first public integration on Zapier
This guide gives an overview of the process to publishing a public integration.
Benefits to building a public integration
- Building a public integration on the Zapier Platform is free.
- There are no fees for publishing an integration.
- Users of your integration are responsible for their own Zapier plans and billing.
- Partners do not incur fees as a result of the usage of their integration.
- You’ll get support from Zapier’s Partner Program once your app has been successfully reviewed.
To see how your integration will show up on Zapier’s website, you can browse the app directory. It’s a great idea to explore similar apps to see what triggers and actions they provide for building Zapier workflows, called Zaps.
1. Before you start
Consider workflows your app will support, and what types of activities your users want to automate. Learn how Zapier works and set up a few Zaps to get a sense of the user experience.
To design useful triggers and actions for your integration, consider how your users might need data from your app to run other parts of their business. Some of the most popular use cases for Zapier integrations include:
- Sending follow-up emails or messages
- Copying data from a bill or invoice into another system
- Updating contact records in multiple databases
- Creating or updating records in a project management tool
Learn more about recommendeded integration features by app category and how to design popular app type integrations.
2. Build your integration
Building a Zapier integration means identifying the relevant APIs for your triggers and actions, and designing an intuitive experience for your users to select and map the data they need.
There are two ways to build an integration on Zapier’s Platform:
- The Platform UI lets you create a Zapier integration in your browser without code using API endpoint URLs. You can set any custom options your API may need, including custom URL params, HTTP headers, and request body items.
- Zapier Platform CLI lets you build a Zapier integration in your local development environment, collaborate with version control and CI tools, and push new versions of your integration from the command line.
Both of these tools run on the same Zapier platform, so choose the one that fits your workflow the best.
Learn more about the difference between building with the Platform UI and the CLI.
3. Test your integration
While you’re building your integration, you can test your API requests within the Integration Builder. For developers building on Zapier Platform CLI, you can write unit tests that run locally, in a CI tool like Travis.
To get a sense of the user experience, it’s recommended to test your integration within the Zap editor. Create a new Zap that uses your integration’s triggers or actions to ensure they all work as expected. After you’re done building, invite users to try your integration before making it available to a wider audience.
Learn more about testing your integration:
4. Submit your integration for app review
After you’ve confirmed your integration is working as expected, you’re almost ready to publish your app. To publish your integration, you need to submit your app for review by Zapier.
Before submitting your integration, review Zapier’s integration publishing requirements or ask the PublishBot for a smoother app review process.
To submit your integration for app review:
- Log into the Platform UI
- Select your integration.
- In Integration Home, click Publish.
- You’ll need to complete the online form.
- Click Submit for Review.
After you’ve submitted your integration for review, one of our developers will reach out to you in 1 week or less with any oustanding requirements. In the meantime, Zapier will update your:
- App version to Pending.
- App status will remain as Private.
5. Beta phase
When your integration is approved, Zapier will update your:
- App status to Beta.
- Integration will be added to Zapier’s app directory with a Beta tag.
Your integration will remain in beta for 90 days. Whilst in public beta, we recommend completing these tasks to improve your integration:
Add help docs to Zapier’s Help Center
The Zapier team provide frontline support for your integration, and in order to provide the best experience for your users, we also host help documentation about your integration in the Zapier Help Center. Help our Technical Writing team create accurate documentation by filling out this form. We can also include link out to documentation on your site to help customers find the information they are looking for.
Once submitted, it takes roughly 2 weeks to get help docs published in the Help Center.
Tip: As you maintain your integration, make sure to use the same form to submit updates at any time to the Technical Writing team.
Create Zap templates
As soon as your app is published and in beta you can begin creating and sharing Zap Templates. Zap Templates are readymade integrations or Zaps with the apps and core fields pre-selected. In a few clicks, they help people discover a use case, connect apps, and turn on the Zap.
Learn more about creating Zap templates.
Embed Zapier in your product or website
The best way to ensure users are able to discover your Zapier integration is to surface your integration where users are looking at it. By embedding Zapier in your product, you can create end-to-end user experience, helping your customers discover available integrations within your product without having to leave your app.
Learn more about embedding Zapier.
Grow active usage
During the beta stage of your integration, it’s important to actively work on growing the usage of your app. By encouraging more people to use your integration, you’ll be able to gather valuable insights and feedback early on, which will help you optimize it further.
Learn more strategy tips for a successful integration.
Manage bugs and feature requests
With the Zapier Issue Manager, you have the ability to conveniently address bugs and new feature requests within your preferred issue-tracking tool. Regularly reviewing and taking action on these items will greatly contribute to enhancing the overall health score of your integration.
Learn more about Zapier Issue Manager.
Exit Beta early by embedding your integration
When one signup for Zapier is detected from your implementation of a Zapier embed tool, you’ll exit Beta the next business day and unlock Partner Program benefits. The simplest option is to feature your Zap templates in a launch announcement. Additionally, you can present a dynamic gallery of the 6,000+ applications that are now compatible with your app for creating workflows.
6. Public phase
After 90 days in public beta, your integration will become public:
- Your app status will be updated to public, and the beta tag will be removed.
- You’re added to our Partner Program, where you can earn marketing and support benefits.
Learn more about maintaining your Zapier integration.