Integrations

Save Connection

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.

post/integrations/connections

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/integrations/connections
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

connection_idstring required

The id the OAuth flow returned.

providerstring required

Stable graph8 provider name.

provider_config_keystring required

Provider config key.

connection_configobject

Provider-specific configuration captured during the flow.

Response

Successful Response

dataConnectionPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.