Skip to content

Create Connection Session Token

POST
/integrations/connections/session-token

Mint a short-lived token for the hosted OAuth flow.

The token is what a browser hands to the connection provider to run the consent screen; this call does not connect anything by itself. The result of that flow comes back to POST /integrations/connections.

The body is optional - omit it to take the app’s default provider.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Any of:

Mint a short-lived token for the hosted OAuth flow.

Both fields are optional because the app’s model has them optional - it falls back to its own default provider. They are NOT interchangeable spellings of one thing: provider is the stable graph8 name and provider_config_key is the key in the connection provider’s own config, and the two can differ per environment.

object
provider
Any of:
string
provider_config_key
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a connection, a token or a migration report.

Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as “nothing went wrong”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string