Skip to content

Save Connection

POST
/integrations/connections

Record a connection the OAuth flow has already established.

This does NOT perform the handshake - the hosted flow does, and this stores its result. connection_id is the id that flow returned, not one you choose.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Record a connection the OAuth flow has already established.

This does NOT perform the OAuth handshake - the hosted flow does that, and this stores its result. connection_id is the id that flow handed back, not one you choose.

object
connection_config

Provider-specific configuration captured during the flow.

object
key
additional properties
string
connection_id
required

The id the OAuth flow returned.

string
provider
required

Stable graph8 provider name.

string
provider_config_key
required

Provider config key.

string

Responses

201

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