← API reference
CANONICAL TYPE REFERENCE

Integration

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

TypeID of the integration (prefix igr)

Reverse-DNS identifier (e.g. com.acme.erp-connector); every version's manifest id. Fixed for the integration's lifetime.

PUBLISHED when a current version exists, else DRAFT

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

The current version, or null until the first publish

The newest version by semantic version, whatever its status

Number of versions (drafts, active and deprecated)

When the integration was created

When the integration last changed, including publishes

View exact SDL
"""
An integration: the parent of its immutable definition versions and the pointer to the current one
"""
type Integration @iac_resource(name: "integration") @iac_guide(ref: "integration-guide") @iac_ops(create: "createIntegration", read: "getIntegration", delete: "deleteIntegration") @iac_replace(strategy: DESTROY_BEFORE_CREATE) {
  """TypeID of the integration (prefix `igr`)"""
  id: IntegrationID! @iac_identity(assignedBy: SERVER) @iac_computed
  """
  Reverse-DNS identifier (e.g. com.acme.erp-connector); every version's manifest `id`. Fixed for the integration's lifetime.
  """
  integrationId: String! @iac_createOnly
  """PUBLISHED when a current version exists, else DRAFT"""
  status: IntegrationStatus! @iac_computed
  """
  TypeID of the current version — the default for new installs. Null until the first publish. Publishing never moves existing instances.
  """
  publishedVersionId: IntegrationDefinitionID @iac_ref(resource: "integration_definition") @iac_writtenBy(operation: "publishIntegration", argument: "versionId")
  """The current version, or null until the first publish"""
  publishedVersion: IntegrationDefinitionState @iac_computed
  """The newest version by semantic version, whatever its status"""
  latestVersion: IntegrationDefinitionState @iac_computed
  """Number of versions (drafts, active and deprecated)"""
  versionCount: Int! @iac_computed
  """When the integration was created"""
  createdAt: ISO8601! @iac_computed
  """When the integration last changed, including publishes"""
  updatedAt: ISO8601! @iac_computed
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.