Integrations
Connections to third-party products, and the actions each one exposes.
List connections
Keys are never included.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
conn_activeconn_idcursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List connections › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a connection
Credentials are passed to the connector service and are not stored by this API.
conn_provider must be the key of one of the providers returned by GET /integrations/providers. That endpoint also says what the provider needs: send its credential.fields as fields and its variables as variables, each keyed by the key given there. A provider that is not in the list is rejected with 422.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a connection › Request Body
conn_nameconn_providerfieldsvariablesallow_writeCreate a connection › Responses
Created
conn_idconn_activeconn_createdconn_updatedconn_nameconn_providerconn_statusconn_configconn_provider_paramsconn_metadataGet a connection
Returns the connection and its status. Credentials are never returned — they are held outside the database and referenced.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a connection › Responses
Success
conn_idconn_activeconn_createdconn_updatedconn_nameconn_providerconn_statusconn_configconn_provider_paramsconn_metadataDelete a connection
Revokes the connection at the provider — every key issued through it stops working immediately — and retires the record. Anything relying on it fails from this point.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a connection › Responses
Success. No content.
Update a connection
Applies the conn_-prefixed fields present in the body. Replacing credentials re-verifies the connection.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a connection › Request Body optional
conn_nameallow_writeUpdate a connection › Responses
Success
conn_idconn_activeconn_createdconn_updatedconn_nameconn_providerconn_statusconn_configconn_provider_paramsconn_metadataSearch operations
Searches the operations this connection exposes — the actions an agent can be given through it.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idquery Parameters
queryHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Search operations › Responses
Success
List providers
The products a connection can be made to, and what each needs to connect. A static catalog, and deliberately a narrowed view of it: the credential recipe internals are not part of the answer.
key is what POST /integrations takes as its conn_provider. variables are the non-secret inputs that provider needs — a subdomain, a region — and credential.fields the secrets it authenticates with; both are keyed the way the create body expects them. Read the list rather than hardcoding it: connectors are added between releases.
Requires the module-external-data license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List providers › Responses
Success