@font-face {
  font-family: "Degular Display - Semibold";
  src: url('https://fonts.zapier.com/Degular/DegularDisplay-Semibold.woff2');
  font-display: fallback;
  font-weight: 400;
}

h1,h2,h3,h4{
  font-family: "Degular Display - Semibold";
  letter-spacing: 1px !important  ;
}


.hero-container {
  display: flex;
  flex-direction: row;
  /* flex-wrap: wrap; */
  align-items: center;
  justify-content: center;
  text-align: left;
  padding: 6rem 2rem;
  width: 80%;
  border-bottom: 2px solid #FF4F00;
  margin: 0 auto;
}
.hero-text {
  width: 600px;
  margin-right: 2rem;
}
@media screen and (max-width: 1300px) {
  .hero-container {
    flex-direction: column;
    text-align: center;
  }
  .hero-text {
    margin-right: 0rem;
    /* Added margin to separate text from image for small screens */
    margin-bottom: 2rem;
  }
  .hero-video {
    max-width: 600px;
  }
}


console.info(
  '%cDig into the Zapier Docs!',
  'font-weight: bold; font-size: 1rem; text-shadow: #474747 2px 2px 2px, 2px 1px 1px rgba(255,79,0,0); color: #FFFFFF; background: #FF4F00; padding: 5px; border: 1px solid #ffffff; border-radius: 2px;'
);

function replaceWithLogoutNav(name) {
  const loginLinkNode =
    document.querySelector('a[href="https://zapier.com/platform/login"]');

  const ul = loginLinkNode.closest('ul');

  const liName = document.createElement('li');
  liName.appendChild(document.createTextNode(name));

  const liLogout = document.createElement('li');
  liLogout.setAttribute('class', 'whitespace-nowrap hidden lg:flex');
  liLogout.setAttribute('id', 'topbar-cta-button');

  const aLogout = document.createElement('a');
  aLogout.setAttribute('href', 'https://zapier.com/logout');
  aLogout.setAttribute('target', '_blank');
  aLogout.setAttribute('class', 'group px-4 py-1.5 relative inline-flex items-center text-sm font-medium');

  const spanFrame = document.createElement('span');
  spanFrame.setAttribute('class', 'absolute inset-0 bg-primary-dark dark:bg-primary-light/10 border-primary-light/30 rounded-full dark:border group-hover:opacity-[0.9] dark:group-hover:border-primary-light/60');

  const divLogout = document.createElement('div');
  divLogout.setAttribute('class', 'mr-0.5 space-x-2.5 flex items-center');

  const spanLogout = document.createElement('span');
  spanLogout.setAttribute('class', 'z-10 text-white dark:text-primary-light');
  spanLogout.appendChild(document.createTextNode('Logout'))

  aLogout.appendChild(spanFrame);
  divLogout.appendChild(spanLogout)
  aLogout.appendChild(divLogout)
  liLogout.appendChild(aLogout);
  ul.replaceChildren(liName, liLogout);
}

fetch('https://zapier.com/api/v4/session', {credentials: 'include'})
  .then(function (response) {
    return response.json();
  })
  .then(function (session) {
    console.info({ session });

    const {
      first_name: name,
      is_logged_in: isLoggedIn,
      // photo_url: photoUrl,
    } = session;

    if (!isLoggedIn) {
      return;
    }

    replaceWithLogoutNav(name);
  });


Community

Blog

Contact Us

Zapier

Home

Developer Platform

Partner Solutions

AI Actions

Sign Up

Developer Platform Login

Platform CLI

Creates a new Authentication for the provided App.  See [here](/guides/custom-flows/adding-an-authentication) to get started.

This API is rate limited. See [Rate Limiting](https://docs.zapier.com/partner-solutions/api-reference/rate-limiting) for more details.

#### OAuth
This endpoint requires the `authentication:write` OAuth scope.

Create Authentication

A branded color that can be used to represent the app.

A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.

            If value is `null`, then no authentication is required to use the app.

Images/icons of various resolutions to represent the app.

An Authentication contains various fields, often credentials such as API tokens, used to access Partner APIs on
behalf of a user. The actual fields are held securely by Zapier

An app that integrates with Zapier. (Expandable)

If `true`, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.

The type of this object.

* `authentication` - authentication

The meta object returned in paginated response bodies.

The total number of objects in the collection represented by the endpoint.

A unique identifier for this particular occurrence of the problem.

A human-readable explanation specific to this occurrence of the problem.

An object containing references to the primary source of the error.

The HTTP status code applicable to this problem.

Populates the `source` object inside our error responses.

A string indicating the name of a single request header which caused the error.

A string indicating which URI query parameter caused the error.

Pointer to the value in the request document that caused the error e.g. `/actions`.

The links object returned in paginated response bodies.

The URL of the next page of paginated results.

The URL of the previous page of paginated results.

A canonical App ID, as provided by the `/apps` endpoint.

Required values to create an authentication. These values will be used by the target integration to successfully create the Authentication. See [here](/guides/custom-flows/adding-an-authentication) for more information.

OAuthAccessTokenAuthentication

Base Response definition to be used in other Response Serializers.

Be sure to include the `data` field after using this class

Welcome

This guide will walk you through what steps you need to take to build an integration from start to finish. There are no fees to build an integration with Zapier.

Introduction

Build your integration on Zapier

There are two different developer tools to build either private or public integrations with on the Zapier Developer Platform: Platform UI or Platform CLI.

Platform UI vs Platform CLI

This tutorial walks you through the process of building an integration on Zapier with authentication, a trigger and an action using the Platform UI.

Platform UI tutorial

This tutorial walks you through the process of building, testing, and pushing an example app to Zapier using Platform CLI. We'll use a mock API for recipes in this tutorial, but for production Zapier apps, you'd want to connect to a real API.

Platform CLI tutorial

Get help building your app integration through the following channels:

Get help with the Zapier Platform

Zapier Glossary

[Zapier is a tool](https://zapier.com/how-it-works) that helps you automate repetitive tasks between two or more apps, no code necessary. Our customers use Zapier to move information from one app to another automatically rather than manually. Each Zap you create starts with a trigger (something that happens in one app) and then one or more actions (something else that happens in another app).

How Zapier works

[Zapier's Developer Platform](https://developer.zapier.com/) includes everything needed to build and manage a new Zapier integration. When you access your integration project by name, you'll see the left sidebar outlines the core project structure.

Zapier integration structure

When building an integration on the Zapier Platform, you must specify the intended audience.

Private vs public integrations

Whether you’re just starting to scope out a new Zapier integration build or have successfully launched your app in the Zapier App Directory, it’s helpful to know what features users find the most valuable and are the most widely used across Zapier’s various [app categories](https://zapier.com/apps). Ensuring your integration covers the foundational triggers, actions, and searches applicable to your app will provide more utility to your users.

Recommended triggers and actions

If you don't have the time/resources to dedicate towards building and launching your own integration, there are Zapier trusted developers who may be able to assist you. These are individuals/groups who have demonstrated their capabilities by satisfying our requirements for building apps on our Developer Platform, and we recommend as a substitute for building your integration in-house.

Zapier trusted app developers

Every Zap starts with a single trigger that watches for new or updated data, starting the user's workflow. Action steps then make use of that data.

Action

Add a create action

Add a search action

Whenever a user selects your app's integration in a Zapier action step, they'll see every _create_ and _search_ action in your integration. 

Reorder or remove action

When adding a _search_ action type, you'll see the option to _Pair an existing search and a create to enable “Find or Create” functionality_ in the _Settings_ page. This embeds the _create_ inside the _search_ step to find or create items in one step of the Zap.

Add a search or create action

Integrations can define environment variables that are available when the app's code executes. They are useful when you have data like an OAuth client ID and secret that you don't want to commit to source control. Environment variables can also be used as a way to toggle between a staging and production environment during app development and this would be recommended instead of the use of an independent integration for staging purposes.

Use environment variables in your API call

If your API returns responses with a status code above 400 that should not automatically throw an error then Zapier recommends enabling skipThrowForStatus.

Add error response handling

Zapier stores data from users' authentication and input forms for API calls in the `bundle` object. You can reference that data in your integration using `{{bundle.bundleName.field}}` text in API requests and connection labels, replacing `bundleName` with the bundle name and `field` with the input field key or API response field key you need.

Reference user-entered details with data bundles

Use Code Mode to refine your API call

The best answer to this lives in our [CLI docs](https://docs.zapier.com/platform/reference/cli-docs#dehydration):

Use hydration in Platform CLI

To enable customers to access your integration by static IP address, all outbound traffic from Zapier to your integration will need to be routed through a smaller set of consistent IP addresses. Any app owner/developer can request to enable the static IP address feature on a private or public app.

Enable static IP address connection for customers

Connecting an app to Zapier starts with authentication. Users select an app they wish to use in their Zap, authenticating their account with that app to allow Zapier to access their data.

Overview

Authentication

API Key authentication passes along a user-entered API Key with every API call. In your Zapier integration using API Key authentication, the API key—and optionally any other data your API needs—is included every time a Zap step runs.

Add authentication with API Key

APIs using Basic Authentication will authenticate users with a username and password. In your Zapier integration using Basic Auth, Zapier includes the username and password credentials in the API request bundle every time Zapier polls an API endpoint for new data or posts new data to an API endpoint.

Add authentication with Basic Authentication

Digest Auth prompts users to enter their username and password, optionally along with any additional data your API requires for authentication. Zapier makes an unauthenticated API call to get the nonce from your server, and uses it to encrypt and pass the authentication data to your server with each API call.

Add authentication with Digest Authentication

OAuth v2 authentication matches in appearance the login process users expect from most modern apps.

Add authentication with OAuth v2

Session authentication has elements of Basic authentication — where Zapier requests a username and password, and OAuth v2 — where Zapier redirects users to the app's site to allow access. User credentials are exchanged for a token used to authenticate subsequent API calls.

Add authentication with Session Authentication

Zapier users can authenticate multiple accounts for any app. By default, every new app account added to Zapier is identified by the app's name, followed by a number (#2, #3, …) for accounts connected after the first.

Add a connection label

When adding a field in your integration's authentication configuration, Zapier offers two field type options; field and computed field. The field option allows users to enter account information needed for authentication.

Use computed fields in OAuth or Session Authentication

Zapier doesn't store the responses from the test API call for OAuth v2 and session authentication. Using computed fields, you can use data from a test API call later in your Zapier integration.

Compute a field from the data of the Test API call

The Request Template is a request editor that lets users set static values that apply to all requests made by this integration. Users can configure the URL params, HTTP headers and request body. This is the perfect place to set authentication fields.

Add authentication fields to Request Template

When adding a subdomain input field, commonly used in OAuth implementations, additional validation is strongly recommended to prevent a potential security vulnerability. If not taken into account, an attacker could utilize a maliciously constructed subdomain field (like `attacker-domain.com/`) in order to redirect OAuth connection requests to that attacker-controlled domain (because `attacker-domain.com/.your-domain.com` resolves to the attacker's domain instead of the expected one). Taking the following steps prevents the potential for an attacker to access your integration's sensitive authentication information, such as the OAuth client ID or secret.

Validate domain and subdomain input fields during authentication

Field types

When building in the Platform UI, you'll use the Input Designer to create the form users will input data into, to send to your app's API.

Add input fields to triggers and actions

Dynamic fields are a type of field built from an API call. Custom code runs to show fields based on other input field data. These are especially useful with project management apps, CRM apps, databases, and any other app where users can add custom, user-defined fields.

Send or receive dynamic user-defined fields through your API

Input fields in Zapier add one item each time the Zap runs. But, if you want users to be able to add multiple items in a single Zap run, then this can be achieved by using a line item group. This group takes line items, which are comma-separated values, and adds each instance of the values to the app in a single Zap run.

Add line item group field to actions

This guide will explain what output data, sample data and output fields are and how to modify them in your triggers or actions.

Output data, defining sample data and output fields

With every API call, Zapier expects the response data to be returned in a specific response type. This can vary depending on what part of your integration you're working on. Use the table below to identify the correct response type to use

Response types Zapier expects

Testing a user's authentication is crucially important, as it is later used to test subsequent trigger and action steps when built.

Test authentication

Once authentication is tested, trigger and action steps are easy to test inside Zapier visual builder. Set up the trigger or action settings and API calls, then as the last step the familiar _Test Your API Response_ box appears. It will show any accounts you added to your integration previously during the authentication testing.

Test triggers or actions

The Zapier platform provides a set of tools to help inform and validate your integration before pushing changes out to users.

Testing Tools

Testing inside the Platform UI is crucial during the building process. To ensure users can benefit from your integration's features, it is equally crucial to test your integration within the Zap editor. This is the best way to notice details that might have been overlooked while building your integration.

Test and monitor your integration in your Zapier account

Trigger

Set up your polling trigger in the Platform UI with the Settings, Input Designer and API Configuration tabs.

Add a polling trigger

Set up your REST Hook trigger in the Platform UI with the Settings, Input Designer and API Configuration tabs.

Add a REST Hook trigger

Triggers are listed in alphabetical order in the Zap editor and this order cannot be changed.

Reorder or remove triggers

Zapier automatically deduplicates incoming trigger data for your integration, so that Zaps do not run multiple times on the same data. Consider the following requirements for your “New Item” and “Updated Item” triggers to work as users expect.

How deduplication works in Zapier

By default, Zapier triggers fetch new or recently updated data to start Zaps, and only need to find the most recently added items. Triggers can also be used to populate [dynamic dropdown fields](/platform/build/add-fields#dynamic-dropdown), and there they need to find all possible items to populate the field.

Use pagination in triggers

REST Hooks are an alternative to polling. The main differences are allowing your customers' Zaps to trigger instantly; and avoiding polling triggers' numerous - and sometimes unnecessary - requests to your API's endpoints to check for new data.

Add an instant trigger using REST Hooks in Zapier Platform CLI

Zapier offers a relatively unique run-time environment for your integration and its requests to your API. The environment is stateless and restricts both execution time and payload size to offer normalized reliability and running time. There are three distinct contexts of this run-time that your integration will need to consider.

Zapier operating constraints

Troubleshoot trigger timeouts

Troubleshoot trigger payload size

Troubleshoot action timeouts

Troubleshoot action payload size

Troubleshoot custom fields

Reduce requests to your API

Troubleshoot throttles

[File dehydration](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#dehydration) is an extremely useful tool to remain within time and size constraints for Zapier triggers and actions. However, it does have its own limits.

Hydration/dehydration limits

When you add a polling trigger or search action to your integration, the Zapier platform [expects a bare array of new or found items returned](/platform/build/response-types), sorted in reverse chronological order. An API may instead return a result _object_ that contains the array of items the trigger/search needs.

Error: An array is expected

Error: Got a non-object result, expected an object from create

When using a REST Hook trigger, the data returned by the perform must be an array.

Error: Got a non-object result in the array, expected only objects

In the Platform UI, when building your authentication, triggers and actions, the default setting under _API Configuration_ is to create each component of your integration using Form Mode.

Use form mode to setup your API calls

Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.

Build with CLI

FAQs

Frequently Asked Questions

Core Reference

CLI Reference

Schema Reference

Integrations do not have a dedicated owner, instead they are managed by a team that can be modified as needed. Add team members to your integration to collaborate, contribute, and view analytics data for your integration on the Developer Platform. Your integration team can have up to 200 team members, regardless of whether your integration is Private or Public.

Add team members to integration

Invite team members to your integration

Before making updates to your integration, it's important to consider the potential impact on user migration and existing Zaps. Ensuring your API and Zapier integration remains backwards compatible is crucial to avoid disruption to users. However, we acknowledge certain changes are sometimes necessary and unavoidable. In such cases, consider the best practice for implementation.

Planning and implementing integration changes

If your API's authentication method changes, you would need to change the method Zapier uses to authenticate user accounts.

Change authentication type

Add required authentication field

Change authentication field keys

Change trigger or action key

Add new required input field

Change input form field key

Change output field key

Change output data response

Change trigger from polling to REST Hook

Update perform method for polling trigger

Changes to your API can impact your integration

The Zapier Platform CLI (Command Line Interface) is a toolset you install and run in your local development environment. It allows you to build, test, and manage your Zapier integration through JavaScript code and terminal commands.

Export integration to Platform CLI

The Zapier Platform UI is the easiest way for anyone with API experience to build Zapier integrations. It is for users more comfortable with a visual form editor.

Export integration to Platform UI

Our shared customers rely on Zapier and your integration for business-critical workflows. Addressing feedback early and often ensures users have the best experience, both with Zapier's platform and yours. Follow these tips on how. 

Essential tips for integrating quality health practices

Prepare for API outages

Zapier recognizes that temporary unavailability is sometimes inevitable for your API.

Embed features are available for public integrations.

Embed insights definitions

For public integrations, Zapier's Support team logs user requests and reported problems in Zapier's issue tracker, that your team can see from the _Bug & Feature Requests_ page in the Manage section.

Respond to user feedback and bugs

Errors from your API cause pain for users at two vital points:

Improve error response handling

At Zapier, churn means a user used your integration in their Zaps 29 - 56 days ago, but hasn't run a successful task in one of those Zaps in the past 28 days. This user is considered to have churned from the integration. Maybe they switched to using a competing integration or their workflow had a more periodic or seasonal cadence.

Active users retention

Integration quality on Zapier boils down to two main pillars: **Health** and **Depth**.

Integration insights definitions

Consider all of the Zaps that users try to create with your integration's triggers, actions, or searches. The Zap activation rate is the percentage of those Zaps that actually activated within 24 hours of creation, meaning the Zap ran at least one successful task.

Zap activation rates

Consider all the user clicks on Zap Templates surfaced in your embeds. The embed activation rate is the percentage of those Zaps that actually activated within 24 hours of creation, meaning the Zap ran at least one successful task. It measures the efefctiveness of the Zapier embeds in your product at converting user clicks on Zap Templates to Zap activations.

Welcome

Workflow API

Workflow Element

Embed Enhancements

Getting Started With the API

Apps

Categories

Accounts

Zap Templates

Zaps

Actions

Authentications

Experimental

Schemas

Create Authentication

OAuth

Authorizations

Body

Response