Install an integration
Installs an app on connected accounts, one for each of the app's account slots.
POST
Installs an app on connected accounts, one for each of the app's account slots. Installing the same app on the same accounts again returns the existing integration.
apiKeyheader
x-api-key<token>application/json- body
app*IntegrationKeyMatch
^[a-z0-9][a-z0-9_-]{0,63}$accounts*settings?Integration
application/json- response
app*IntegrationKeyMatch
^[a-z0-9][a-z0-9_-]{0,63}$settings*id*IntegrationIdMatch
^intg_[0-9a-hjkmnp-tv-z]{16,24}$status*IntegrationStatusValue in
"pending""connected""needsReconnect"accounts*supportsContactAccounts*booleananswerWithoutApproval*AnswerWithoutApprovaltools*array<>toolPage*installedBy*|nullcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.integrations.install({
"app": "example",
"accounts": {}
});Example Response
{
"app": "string",
"settings": {
"property1": "string",
"property2": "string"
},
"id": "string",
"status": "pending",
"accounts": {
"property1": "string",
"property2": "string"
},
"supportsContactAccounts": true,
"answerWithoutApproval": true,
"tools": [
{
"name": "string",
"title": "string",
"kind": "query",
"effect": "read",
"guards": [
"pinnedDestination"
],
"granted": true,
"unavailableReason": "input_schema_too_large",
"enabled": true,
"runsWithoutApproval": true
}
],
"toolPage": {
"nextOffset": 0,
"total": 0,
"revision": "string"
},
"installedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}