Developer APIResourcesConnections

Create connection

Creates a new connection. This endpoint supports the following actions: - Create a shell connection - Create and authenticate a connection <Note title="OAUTH AUTHENTICATION NOT SUPPORTED"> This endpoint does not support the ability to create and authenticate a connection for OAuth type connections. However, you can use this endpoint to create a shell connection for your OAuth connections.</Note>

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
providerstringRequired

Connector identifier. For example, Salesforce and more.

namestringOptional

Connection name. For example, Prod Salesforce connection and more.

folder_idintegerOptional
Folder id where connection should be stored.
parent_idintegerOptional
ID of parent connection.
external_idstringOptional
External identifier given to the user who owns the runtime user connection.
shell_connectionbooleanOptional
Specifies whether the connection is a shell connection or an authenticated connection. Defaults to `false` if not specified. If `shell_connection` is `false`, credentials are passed, and the connection is tested and established. If `shell_connection` is `true`, credentials are passed, but the connection isn't tested or established, and additional actions are required for authentication.
inputmap from strings to anyOptional
Connection setting fields.
oauth_token_pairobjectOptional

Response

Success reply
idinteger or null
The unique identifier for the connection.
namestring or null
The name of the connection.
providerstring or null
The provider associated with the connection.
authorized_atstring or null
The timestamp when the connection was authorized.
authorization_statusstring or null
The status of the connection authorization.
authorization_errorstring or null
Details of any authorization errors, if applicable.
created_atstring or null
The timestamp when the connection was created.
updated_atstring or null
The timestamp when the connection was last updated.
external_idstring or null
The external ID associated with the connection, if any.
folder_idinteger or null
The ID of the folder containing the connection.
parent_idinteger or null
The ID of the parent connection, if applicable.

Errors