Create Authentication

curl --request POST \
  --url https://api.zapier.com/v2/authentications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "title": "My new auth",
    "app": "8cdbc496-c95c-4f19-b3a3-fee03ed5f924",
    "authentication_fields": {
      "secret": "example_E4CrHVvRuxTXrPFLyyZFeRJwJcx2ELQZ"
    }
  }
}
'

{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "count": 1,
    "limit": 1,
    "offset": 0
  },
  "data": [
    {
      "type": "authentication",
      "id": "example_DOb4nWkz",
      "app": "a8aaed31-e257-4479-aaa9-ca02fe2fab04",
      "is_expired": false,
      "title": "Example zapier@example.com #5"
    }
  ]
}

POST

authentications

curl --request POST \
  --url https://api.zapier.com/v2/authentications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "title": "My new auth",
    "app": "8cdbc496-c95c-4f19-b3a3-fee03ed5f924",
    "authentication_fields": {
      "secret": "example_E4CrHVvRuxTXrPFLyyZFeRJwJcx2ELQZ"
    }
  }
}
'

{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "count": 1,
    "limit": 1,
    "offset": 0
  },
  "data": [
    {
      "type": "authentication",
      "id": "example_DOb4nWkz",
      "app": "a8aaed31-e257-4479-aaa9-ca02fe2fab04",
      "is_expired": false,
      "title": "Example zapier@example.com #5"
    }
  ]
}

This API is rate limited.

Authorizations

Authorization

string

header

required

See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication

Body

application/json

Inputs to create a new Authentication

data

object

required

The object used to create a new Authentication

Show child attributes

data.title

string

required

The title of the authentication.

Maximum string length: 255

data.app

string<uuid>

required

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

data.authentication_fields

object

required

Required values to create an authentication. These values will be used by the target integration to successfully create the Authentication. See our Adding an Authentication guide for more information.

Show child attributes

data.authentication_fields.{key}

any

Response

Base Response definition to be used in other Response Serializers.

Be sure to include the data field after using this class

links

object

required

The links object returned in paginated response bodies.

Show child attributes

links.next

string | null

The URL of the next page of paginated results.

links.prev

string | null

The URL of the previous page of paginated results.

meta

object

required

The meta object returned in paginated response bodies.

Show child attributes

meta.count

integer

required

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

Required range: x >= 0

meta.limit

integer | null

required

The limit value used in the request.

Required range: x >= 1

meta.offset

integer

default:0

The offset value used in the request.

Required range: x >= 0

data

object[]

The Authentications present, provided they exist

Show child attributes

data.type

enum<string>

default:authentication

required

The type of this object.

authentication - authentication

Available options:

authentication

data.id

string

required

The identifier for this specific Authentication

data.app

required

An app that integrates with Zapier.

Show child attributes

data.app.id

string

required

Unique id of the app

data.app.image

string

required

Default image/icon to represent the app.

data.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. Client ID-authenticated requests will never have this object's fields populated.

Show child attributes

data.app.links.{key}

any

data.app.action_types

any[]

required

A list of action types for this specific App

data.app.title

string

required

Human readable name of the app

data.app.images

object

required

The URL of images (of various sizes) for this specific App

Show child attributes

data.app.images.url_16x16

string

required

16x16 resolution image URL

data.app.images.url_32x32

string

required

32x32 resolution image URL

data.app.images.url_64x64

string

required

64x64 resolution image URL

data.app.images.url_128x128

string

required

128x128 resolution image URL

data.app.hex_color

string

required

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

data.app.categories

object[]

required

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

Show child attributes

data.app.categories.slug

string

required

The shortened slug name for this category

data.app.description

string

required

Human readable description of the app.

data.app.type

string

default:app

The type of this object.

data.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.

data.title

string

required

The title of this specific Authentication

Get Authentications Get Apps [v2]

⌘I

Powered By Zapier

API Authentication

Embedding Zapier

Embedding Zapier MCP

Zap Creation

Running Actions

Sponsor User Automation

Managing App Authentications

Zap Templates

AI Workflows

API Specification

Create Authentication

When using OAuth

Authorizations

Body

Response