Welcome
Workflow API
Workflow Element
Embed Enhancements
Getting Started With the API
Categories
Accounts
Zap Templates
Authentications
Experimental
Schemas
- Common Types
Categories
Accounts
Zap Templates
Authentications
Experimental
Create Authentication
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.
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
See our OAuth2 authentication documentation
Body
Inputs to create a new Authentication
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 our Adding an Authentication guide for more information.
The title of the authentication.
255
Response
Base Response definition to be used in other Response Serializers.
Be sure to include the data
field after using this class
The meta object returned in paginated response bodies.
An app that integrates with Zapier. (Expandable)
A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
Human readable description of the app.
A branded color that can be used to represent the app.
Unique id of the app
Default image/icon 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.
Human readable name of the app
The type of this object.
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
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"
}
]
}