InstallIntegrationBody

Request body for an Integration operation.

Definition

TypeScript

interface InstallIntegrationBody {
  workspaceId: string;
  integrationVersionId?: string | undefined;
  variables?: Record<string, unknown> | undefined;
  authStateId?: string | undefined;
  memberPolicy?: "manual" | "auto_all" | "auto_defaults" | undefined;
  parentInstallId?: string | undefined;
  selectedMemberSlugs?: Array<string> | undefined;
}

Fields

Field	Type	Notes
`workspaceId`	`string`	`required` — Destination workspace to install into.
`integrationVersionId`	`string \| undefined`	`optional` — Pin to a specific version. Defaults to the integration's current_version.
`variables`	`Record<string, unknown> \| undefined`	`optional` — Resolved values for the integration's variables_schema.
`authStateId`	`string \| undefined`	`optional` — Workspace secret reference (auth credentials). Required when auth_config.type !== 'none'.
`memberPolicy`	`"manual" \| "auto_all" \| "auto_defaults" \| undefined`	`optional`
`parentInstallId`	`string \| undefined`	`optional` — For add-ons: the parent install this one extends.
`selectedMemberSlugs`	`Array<string> \| undefined`	`optional` — Which manifest member slugs to materialize. Defaults to required + defaultEnabled.