Skip to main content
POST
Connect an account

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Path Parameters

app
string
required

App slug

Body

application/json
authScheme
string

Which scheme to connect through, from GET /integrations/:app/auth. Defaults to the one asking for least setup

Example:

"API_KEY"

appCredentials
object

Credentials of your own application with the provider, keyed by the scheme's appFields. Needed once per workspace for apps the integration provider holds no credentials for; ignored afterwards

Example:
accountFields
object

What this account supplies, keyed by the scheme's accountFields — an API key, the subdomain of your instance

Example:

Response

Success

connected
boolean
required

True when the account is connected already — API-key apps have nothing to authorise, so no browser is involved

authorizationUrl
string

Open this URL in a browser to authorise the account. Absent when connected is already true