Create an integration connection
create_integration_connectionCreates a connection for an integration in your Orchestra workspace, storing its auth parameters and restricting which environments may use it.
Instructions
Create a connection for an integration in the caller's workspace. parameters must match the integration's authSchema, as returned by Get an integration. allowedEnvironmentIds restricts the connection to pipelines in those environments, and needs environment edit permission on every environment left out; omit it to allow every environment. Secret parameters are obfuscated in the response. OAuth integrations return a redirectUrl instead and need a user's credential.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"integration": "<integration>",
"connectionName": "<connectionName>",
"parameters": "<parameters>"
},
"name": "create_integration_connection"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| parameters | Yes | Auth parameters, keyed by the field names in the integration's authSchema. | |
| integration | Yes | ||
| callbackPath | No | ||
| connectionName | Yes | Display name for the connection. | |
| credentialStore | No | Where the secrets live. ORCHESTRA stores them encrypted in Orchestra; an external store takes that store's reference parameters instead. | ORCHESTRA |
| validationParams | No | Parameters matching the integration's validateSchema. Supplying them runs an extra validation against the provider once the connection authenticates. | |
| allowedEnvironmentIds | No | Environments whose pipelines may use the connection. Empty means every environment. | |
| X-Orchestra-Account-Id | No | Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||