Sign in

v2

latestOpenAPI 3.1.02026-08-05313314398.1 KB
integrations

Create Integration

Register or update an integration for the company (upsert by provider).

Handles three paths:

  • Nango OAuth: nango_connection_id provided → mark connected.
  • Custom credentials: credentials dict provided → validate, test, encrypt.
  • Neither: mark disconnected.

Per-resource permissions: any company member may CREATE a new integration (they're auto-granted ADMIN on it); updating an existing (company, provider) row in place requires EDITOR on that integration.

post/api/v1/integrations/

Request body

provider_idstring uuid required
nango_connection_idstring nullable
credentialsobject nullable

Response

Successful Response

idstring uuid required
company_idstring uuid required
user_idstring uuid required
provider_idstring uuid required
nango_connection_idstring nullable required
statusstring required
has_credentialsboolean
connected_atstring date-time nullable required
created_atstring date-time required