Connect

[POST] .../v1/integration/connect

Connects an available replicable integration to the account. Use this method after selecting a public integration from the available-integration catalog and before reading or editing the connected integration settings. The method creates an access token, generates a connected_integration_id, saves the connected integration row, stores default settings, optionally creates scheduler data, notifies the external integration registry and returns a standard OkResult with no payload. The request body is required and key must identify an available public integration; public integration connections are active immediately after the connection workflow completes. The current request user must have permission to manage other users' public integrations and the integration tariff option must be enabled for public integrations. Missing body, missing key, denied access, unavailable tariff option, integration not found, access-token creation failure, external registry connection failure, settings save failure and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
key String Optional Integration key, which is the system name.

Request Example

{
  "key": "marketplace_toserver"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.

Response Example

{
  "ok": true,
  "result": null
}