data

Connect an Integration

Establish a new integration for a workspace, routing on the connector type: collect an API key, kick off an OAuth redirect, or track a social handle. Use when a user picks a provider from the catalog and wants it connected. Returns the created connection, or an OAuth authorize URL to redirect to. Creates and stores the connection without starting a sync.

post/api/platform/v1/connections

Request

  • Base URL: https://docs.amdahl.ai
  • URL: https://docs.amdahl.ai/api/platform/v1/connections
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

connector_typestring required

Catalog connector type to connect (e.g. hubspot, fathom, twitter).

namestring

Optional display label for this connection instance.

scope'business' | 'personal'

Ownership: business (workspace-wide) or personal. Defaults from the catalog.

api_keystring

For api_key connectors: the API key / token to store (encrypted).

api_idstring

For an api_key connector whose credential is a PAIR (today only Aircall, whose API is HTTP Basic): the non-secret id half, pasted alongside the token in api_key. Read connections.list_catalog to see whether a connector asks for it.

base_urlstring

For the computer_agent connector: its deployment base URL (http/https).

account_handlestring

For social (handle) connectors: the resolved bare account handle.

external_account_idstring

For social (handle) connectors: the provider's stable account id.

display_namestring

For social (handle) connectors: display name snapshot.

avatar_urlstring

For social (handle) connectors: avatar image URL snapshot.

followersinteger

For social (handle) connectors: follower count snapshot.

return_tostring

For oauth connectors: console URL to redirect back to after the handshake (first-party origins only).

Response

OK

dataunknown

Changes

No recorded changes to this operation across all 1 revision of this API.