Action

An Action is an operation that can be performed against a third-party API; either a read or a write. A Zap is composed of a read, followed by one or more writes.

string

required

key

string

required

The developer provided identifier for this Action

app

required

Apps (Expandable)

app.id

string

required

Unique id of the app

app.image

string

required

Default image/icon to represent the app.

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.

app.action_types

any[]

required

app.title

string

required

Human readable name of the app

app.images

object

required

Images/icons of various resolutions to represent the app.

app.hex_color

string

required

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

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.

app.description

string

required

Human readable description of the app.

app.type

string

default:app

The type of this object.

type

enum<string>

required

The type of this object

action - action

Available options:

action

action_type

enum<string>

required

The type of this Action

READ - READ
WRITE - WRITE

Available options:

action

is_instant

boolean

required

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

title

string

required

The title of this Action.

description

string

required

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

Was this page helpful?

Create a Workflow step App

Copy
{
  "id": "<string>",
  "key": "<string>",
  "app": {
    "id": "<string>",
    "type": "app",
    "image": "<string>",
    "links": {},
    "action_types": [
      "<any>"
    ],
    "title": "<string>",
    "images": {
      "url_16x16": "<string>",
      "url_32x32": "<string>",
      "url_64x64": "<string>",
      "url_128x128": "<string>"
    },
    "hex_color": "<string>",
    "categories": [
      {
        "slug": "<string>"
      }
    ],
    "description": "<string>"
  },
  "type": "action",
  "action_type": "action",
  "is_instant": true,
  "title": "<string>",
  "description": "<string>"
}

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