← All resources

Resource

integration

An integration: the parent of its immutable definition versions and the pointer to the current one

GraphQL reference →

Configuration

integrationIdString!RequiredSet on creation

Reverse-DNS identifier; must be new for this tenant

set once, at creation

publishedVersionIdIntegrationDefinitionIDOptional

TypeID of the current version — the default for new installs. Null until the first publish. Publishing never moves existing instances.

References integration_definition

written by `publishIntegration`, not by this resource's update

Read-only values

Show values
idIntegrationID!Read only

TypeID of the integration (prefix igr)

computed by the platform

statusIntegrationStatus!Read only

PUBLISHED when a current version exists, else DRAFT

Allowed values

DRAFT — No current version yet: nothing is offered to new installs.

PUBLISHED — A current version exists; new installs get it by default. Existing instances keep the version they were installed from until they are upgraded explicitly.

computed by the platform

publishedVersionIntegrationDefinitionStateRead only

The current version, or null until the first publish

computed by the platform

latestVersionIntegrationDefinitionStateRead only

The newest version by semantic version, whatever its status

computed by the platform

versionCountInt!Read only

Number of versions (drafts, active and deprecated)

computed by the platform

createdAtISO8601!Read only

When the integration was created

computed by the platform

updatedAtISO8601!Read only

When the integration last changed, including publishes

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.