cURL
Python
JavaScript
PHP
Go
Java
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 .
See our OAuth2 authentication documentation
Body application/json application/x-www-form-urlencoded multipart/form-data
Inputs to create a new Authentication
The title of the authentication.
Maximum length: 255
A canonical App ID, as provided by the /apps endpoint.
data. authentication_fields
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.
data.authentication_fields. {key}
Base Response definition to be used in other Response Serializers.
Be sure to include the data field after using this class
The links object returned in paginated response bodies.
The URL of the next page of paginated results.
The URL of the previous page of paginated results.
The meta object returned in paginated response bodies.
The total number of objects in the collection represented by the endpoint.
Required range: x >= 0
The limit value used in the request.
Required range: x >= 1
The offset value used in the request.
Required range: x >= 0
An Authentication contains various fields, often credentials such as API tokens, used to access Partner APIs on
behalf of a user. The actual fields are held securely by Zapier
data. type
enum<string>
default: authentication
required The type of this object.
authentication - authentication Available options:
authentication
An app that integrates with Zapier. (Expandable)
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
Images/icons of various resolutions to represent the app.
data.app.images. url_16x16
data.app.images. url_32x32
data.app.images. url_64x64
data.app.images. url_128x128
A branded color that can be used to represent the app.
A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
Category an app belongs to.
Human readable description of the app.
If true, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.
