v3
latestOpenAPI 3.0.02026-07-31278263961.8 KBCreate a new integration
Request body
Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.
Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.
Display name. Optional on create; used to generate key when key is omitted.
Optional human-readable description.
Optional key-value metadata.
External app id; alternative to connectorId — resolves to the app's default connector.
ID of the connector this integration uses.
Key of the connector; alternative to connectorId. Resolved to connectorId by the API.
Connector-specific parameters (e.g. OAuth { clientId, clientSecret, scopes }).
[Experimental] Intent-based instruction for an agent to configure this element.
Response
Display name. Always present in API responses (filled by API if not set on create).
Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.
Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.
Optional human-readable description.
Optional key-value metadata.
Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.
Opaque revision token; changes on each update. Used for optimistic concurrency.
ISO date when the element was created.
ISO date when the element was last updated.
When true, the element cannot be modified (e.g. published package elements or elements from another workspace).