Create a Zap

POST

zaps

curl --request POST \
  --url https://api.zapier.com/v2/zaps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "steps": [
      {
        "action": "example_core:5m2y9p7J",
        "inputs": {
          "code": "output = [{id: Math.round(Date.now()/1000), n: Math.random()}];"
        },
        "authentication": null
      },
      {
        "action": "example_core:VBz2NGB5",
        "inputs": {
          "code": "output = [{ id: inputData.id, n: inputData.n * 2}];",
          "inputs": {
            "n": "{{n}}",
            "id": "{{id}}"
          }
        },
        "authentication": null
      }
    ],
    "title": "My Critically Important Program"
  }
}'

{
  "type": "zap",
  "id": "104826178",
  "is_enabled": true,
  "last_successful_run_date": null,
  "updated_at": "2024-03-14T22:02:36+00:00",
  "title": "My Critically Important Program",
  "links": {
    "html_editor": "https://zapier.com/editor/104826178?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=None",
    "steps": [
      {
        "action": "example_core:Vn7xbE60",
        "authentication": "Krjvl500",
        "inputs": {},
        "title": null
      },
      {
        "action": "example_core:V7GpzX40",
        "authentication": null,
        "inputs": null,
        "title": null
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

See our OAuth2 authentication documentation

Query Parameters

expand

string

A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.

Body

data

object

required

See our Building a Zap guide to get started.

Response

201

application/json

A Zap is an automated workflow that connects your apps and services together.

type

string

required

The type of this object.

string

required

A unique identifier of the Zap.

last_successful_run_date

string | null

required

The date/time at which this Zap last ran successfully. A null value indicates that a Zap has never run successfully.

updated_at

string

required

title

string

required

The human readable name of the Zap.

links

object

required

steps

required

ExpandedZapStep (Expandable)

steps.action

required

Action (Expandable)

steps.action.id

string

required

steps.action.key

string

required

The developer provided identifier for this Action

steps.action.app

required

Apps (Expandable)

steps.action.app.id

string

required

Unique id of the app

steps.action.app.image

string

required

Default image/icon to represent the app.

steps.action.app.links

object

required

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.

steps.action.app.action_types

any[]

required

steps.action.app.title

string

required

Human readable name of the app

steps.action.app.images

object

required

Images/icons of various resolutions to represent the app.

steps.action.app.hex_color

string

required

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

steps.action.app.categories

object[]

required

A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.

Category an app belongs to.

steps.action.app.description

string

required

Human readable description of the app.

steps.action.app.type

string

default:app

The type of this object.

steps.action.type

enum<string>

required

The type of this object

action - action

Available options:

action

steps.action.action_type

enum<string>

required

The type of this Action

READ - READ
WRITE - WRITE

Available options:

action

steps.action.is_instant

boolean

required

Will be set to true if this Action triggers instantly. May only be true when type is READ.

steps.action.title

string

required

The title of this Action.

steps.action.description

string

required

A longer description of this Action, usually describing what it does in more detail.

steps.authentication

required

Authentication (Expandable)

steps.authentication.type

enum<string>

default:authentication

required

The type of this object.

authentication - authentication

Available options:

authentication

steps.authentication.id

string

required

steps.authentication.app

required

An app that integrates with Zapier. (Expandable)

steps.authentication.app.id

string

required

Unique id of the app

steps.authentication.app.image

string

required

Default image/icon to represent the app.

steps.authentication.app.links

object

required

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.

steps.authentication.app.action_types

any[]

required

steps.authentication.app.title

string

required

Human readable name of the app

steps.authentication.app.images

object

required

Images/icons of various resolutions to represent the app.

steps.authentication.app.hex_color

string

required

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

steps.authentication.app.categories

object[]

required

A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.

Category an app belongs to.

steps.authentication.app.description

string

required

Human readable description of the app.

steps.authentication.app.type

string

default:app

The type of this object.

steps.authentication.is_expired

boolean

required

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

steps.authentication.title

string

required

steps.inputs

any

required

steps.title

string | null

required

The custom title of a Zap Step. If a step has not been given a custom title by the user, then the value will be null.

is_enabled

boolean

default:true

Whether the Zap is enabled (running) or not.

Was this page helpful?

Get Zaps [v2]Get Actions

curl --request POST \
  --url https://api.zapier.com/v2/zaps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "steps": [
      {
        "action": "example_core:5m2y9p7J",
        "inputs": {
          "code": "output = [{id: Math.round(Date.now()/1000), n: Math.random()}];"
        },
        "authentication": null
      },
      {
        "action": "example_core:VBz2NGB5",
        "inputs": {
          "code": "output = [{ id: inputData.id, n: inputData.n * 2}];",
          "inputs": {
            "n": "{{n}}",
            "id": "{{id}}"
          }
        },
        "authentication": null
      }
    ],
    "title": "My Critically Important Program"
  }
}'

{
  "type": "zap",
  "id": "104826178",
  "is_enabled": true,
  "last_successful_run_date": null,
  "updated_at": "2024-03-14T22:02:36+00:00",
  "title": "My Critically Important Program",
  "links": {
    "html_editor": "https://zapier.com/editor/104826178?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=None",
    "steps": [
      {
        "action": "example_core:Vn7xbE60",
        "authentication": "Krjvl500",
        "inputs": {},
        "title": null
      },
      {
        "action": "example_core:V7GpzX40",
        "authentication": null,
        "inputs": null,
        "title": null
      }
    ]
  }
}

Welcome

Workflow API

Workflow Element

Embed Enhancements

Getting Started With the API

Apps

Categories

Accounts

Zap Templates

Zaps

Actions

Authentications

Experimental

Schemas

Apps

Categories

Accounts

Zap Templates

Zaps

Actions

Authentications

Experimental

OAuth

Authorizations

Query Parameters

Body

Response