Build your integration on Zapier

You can choose to build with either Zapier Platform UI or Zapier Platform CLI.

​

1. Prerequisites

• The app you wish to integrate will need to have a publicly-accessible API
• Create a Zapier account
• If you haven’t used Zapier before, learn the basics in our Zapier Getting Started Guide

​

2. Choose a developer tool

Select one of the 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. You can try both methods out with the Platform UI tutorial and the Platform CLI tutorial.

​

3. Create a new integration

Create and add details about your integration. Set your Intended audience.

• Create an integration using Zapier Platform UI
• Create an integration using Zapier Platform CLI

​

3. Add an authentication scheme

Configuring authentication allows users to input credentials to authenticate with your API.

• Authentication using Zapier Platform UI

• Authentication using Zapier Platform CLI

  • Authentication schema

​

4. Configure triggers

Triggers are how your app’s users can start automated workflows whenever an item is added or updated in your app. Use webhook subscriptions or polling API endpoints to create triggers.

• Configure a trigger using Zapier Platform UI

• Configure a trigger using Zapier Platform CLI

• Trigger schema

​

5. Configure actions

Actions allow users to either create, search or update records in your app via your API.

• Create an action using Zapier Platform UI

• Create an action using Zapier Platform CLI

  • Search schema
  • Create schema

​

6. Test your integration

While you’re building your integration, you can test your API requests within the Platform UI. 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:

• Testing using Zapier Platform UI
• Testing using Zapier Platform CLI

​

7. Validate your integration

Run automated checks to identify errors and recommendations on how to improve the user experience of your private integration. These checks are required to pass for public integrations, and are recommended for a better user experience for private integrations.

• Run automated checks using Zapier Platform UI
• Run automated checks using Zapier Platform CLI

​

8. Invite team members

You can assign different roles and permissions to team members who you’re collaborating with on your private integration.

• Invite team members using Zapier Platform UI
• Invite team members using Zapier Platform CLI

​

9. Publish

Once you’ve built your integration, Publish it!

• Share your integration

​

10. Conclusion

Once you’ve built your integration, continue to make further improvements and manage versions of your integration.

• Manage integration versions using Zapier Platform UI
• Manage integration versions using Zapier Platform CLI