@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);
  });


<string>

Zapier

Welcome

Developer Platform Login

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

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

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

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.

Overview

Build with CLI

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

FAQs

Frequently Asked Questions

Core Reference

CLI Reference

Schema Reference

When you make a new integration in Zapier CLI, you can add the app's name, description, and homepage to the `package.json` file.

Add integration branding in Platform CLI

Our partner solutions are the easiest ways to embed Zapier and surface integrations within your product.

Partner Solutions Documentation

[Transfer](https://help.zapier.com/hc/en-us/articles/8496274335885) is a Zapier functionality that enables users to perform bulk operations using their historical data.

Transfer

Zapier's [AI Actions](https://actions.zapier.com/) is an AI alpha product designed to work with natural language-based products. It leverages the Zapier platform, with over [6000 apps](https://zapier.com/apps). You can include the capabilities of Zapier's platform in your own product.

AI Actions

[Custom Actions](https://help.zapier.com/hc/en-us/articles/16276574838925-App-Extensions-in-Zapier) and [API Requests](https://help.zapier.com/hc/en-us/articles/12899607716493-Set-up-an-API-request-action#prerequisites-0-0) are features that have been developed internally at Zapier, designed to help our mutual customers achieve the most value out of your app integration.

Custom Actions and API Requests Actions

This guide provides instructions on editing and maintaining existing scripting methods for legacy web builder integrations that have been converted to either the Platform UI or Platform CLI.

Scripting in converted Legacy Web Builder Integrations

Changelog

Add automation to your product with Zapier.

Zapier Partner Solutions

Our most powerful tool for building native workflows in your product

Integrate the Workflow API

Listing apps available on Zapier is a simple way to show users all of what's possible on Zapier

Retrieving Apps on Zapier

Listing a users zaps reveals existing workflows created by users.

Retrieving a list of users Zaps

Zap templates are pre-made Zaps that help users discover popular use cases for automating their work. Each template features a specific use case and the apps needed for it to work.

Retrieving Zap Templates

With an embedded Zap editor in your product, your users can create and edit their Zaps without leaving your app.

Embedding the Zapier Editor

The Workflow Element is a prebuilt UI component that offers the quickest—and easiest—way to surface your Zapier integration directly within your own product.

Embed the Workflow Element

Keeping our elements secure and usable is critical at Zapier

Element Security

Insights are available to review the performance of your embed, and track usage growth.

Embed Insights

Prefills allow you to define the input fields on behalf of the user, simplying the experience of setting up their Zap.

Pre-filled Zaps

Quick Account Creation is a seamless, accelerated sign-up feature allowing first time Zapier users to skip the standard sign-up procedure and onboarding survey. Enabling Quick Account Creation as part of your embed tool code helps provide a more frictionless experience for end users.

Quick Account Creation

Authenticate with The Zapier Workflow API

Zapier Authentication

Rate limits when accessing the Workflow API   

Rate Limiting

This endpoint returns a list of apps sorted popularity. See the List Apps guide to get started.

Get Apps [v1]

This endpoint returns a list of apps sorted by popularity.

#### OAuth

This endpoint requires the `zap` OAuth scope.

Get Apps [v2]

Get Categories

This endpoint returns the authenticated user information

#### OAuth

This endpoint requires the `profile` OAuth scope.

User Profile

Create a new user and obtain an access token. See our Quick Account Creation guide to get started.

Create Account

List popular Zap Templates using your app. See our List Zap Templates guide to get started.

Get Zap Templates

This endpoint returns a list of Zaps for the authenticated Zapier user.

#### OAuth

This endpoint requires the `zap` OAuth scope.

Get Zaps [v1]

This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.

Guess a Zap [Beta]

This endpoint returns a list of Zaps for the authenticated Zapier user.

The `expand` array can be used to expand selected fields into full objects in the response.  Inputs with keys can
also be passed to filter Zaps by certain criteria.

#### OAuth

This endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scope.

Get Zaps [v2]

This URL creates a Zap based on the given steps and title.

#### OAuth

This endpoint requires the `zap:write` OAuth scope.

Create a Zap

Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. Action IDs may not be reused, see our documentation for how to hardcode a particular action.

#### OAuth

This endpoint requires the `zap` OAuth scope.

Get Actions

Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.

#### OAuth

This endpoint requires the `zap:write` OAuth scope.

Get Input Fields

Get the possible values for a `SELECT` Input Field.

#### OAuth

This endpoint requires the `zap` OAuth scope.

Get Choices

Get the Output Fields for a particular Action, using the provided authentication and inputs.

#### OAuth

This endpoint requires the `zap:write` OAuth scope.

Get Output Fields

Tests the action (step) in the third party api, using the provided authentication and inputs.

#### OAuth

This endpoint requires the `zap:write` OAuth scope.

Step Test

Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it's not possible to create Zaps with Authentications you don't own.

#### OAuth

This endpoint requires the `authentication` OAuth scope.

Get Authentications

Creates a new Authentication for the provided App. See our Adding an Authentication guide to get started.

#### OAuth

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

Create Authentication

Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.

In the example request body the Workflow Step contains the field values `email`, `name`, `phone`, and `address` in double curly braces. Then the webhook URL returned can be called with a `POST` request containing a JSON body in the following format:

```
{
"email": "user@example.com",
"name": "John Doe",
"phone": "1234567890",
"address": "123 Maple Lane"
}
```

Note that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.

#### OAuth

This endpoint requires the `zap:write` OAuth scope.

Create a Workflow step

This endpoint returns runs for the specified Zaps and provides basic yet essential details about their execution. As the initial version, it serves foundational information, with plans for continuous enhancement to expand its capabilities and improve data output over time.

#### OAuth

This endpoint requires the `zap:runs` OAuth scope.

Get Zap Runs

AI Actions exposes Zapier's 7,000+ apps and 30,000+ actions, for selected partners, to build your own custom AI assistants.

Learn how to kick-start AI Actions by obtaining a partner key, setting up allowed actions, and executing an action through our API.

Quickstart

Authentication

Get a list of Zapier accounts for the current user.

Zapier account list

Stored Vs. Stateless Actions

Stateless action creator/runner

OpenAPI Specification

API Key

API Logs

Join our Community

Submit an issue

Community

Blog

Contact Us

Home

Developer Platform

Partner Solutions

Sign Up

Platform CLI

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

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

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.

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.

Welcome

Workflow API

Workflow Element

Embed Enhancements

Getting Started With the API

Apps

Categories

Accounts

Zap Templates

Zaps

Actions

Authentications

Experimental

Schemas