Skip to main content
POST
Complete a provider connection

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

provider
string
required

Provider identifier, such as slack or github.

Query Parameters

state
string
required

Signed one-time value supplied through the connection URL.

code
string

Authorization code supplied by the provider when required.

installation_id
string

Installation identifier supplied by providers such as GitHub.

location
string

Provider data-center location supplied by multi-region providers such as Zoho.

callback_source
string

Fixed compatibility marker added by the legacy API relay. Browser callers omit it.

Response

The grant landed and no dashboard page could be named to send the person to

The connect landed and no dashboard page could be named to send the person to.

POST /v1/connectors/{provider}/callback answers this as a 200, never as a failure. The grant is sealed and the connection is live by the time this is written. An error would tell a person their connect did not work when it did, and the next thing they would do is press Connect again.

status
string
required

Always connected; the same word a status read answers once the grant has landed.