← All resources

Resource

integration_definition

An integration definition (immutable, versioned)

GraphQL reference →

Configuration

sourceXMLintegration_documentRequired

Integration document, including its actors and API clients.

integration_document fields

Open model reference →

XML v1 definition of Integration behavior and required configuration.

object
actorOptional
apiClientsOptional
configurationSchemaOptional
customAppsOptional
dataContainerSchemasOptional
descriptionOptional
edgeAppsOptional
integrationIdRequired

^[a-z0-9][a-z0-9-](.[a-z0-9][a-z0-9-])+$

string
Pattern
"^[a-z0-9][a-z0-9-]*(\\.[a-z0-9][a-z0-9-]*)+$"
Minimum length
1
policyOptional
protobufOptional
resourcesOptional
sdkVersionRequired

^[0-9]+.[0-9]+$

string
Pattern
"^[0-9]+\\.[0-9]+$"
Minimum length
1
timeoutMsOptional

Integer 1...60000; runtime default 5000

integer
Minimum
1
Maximum
60000
versionRequired

^[0-9]+.[0-9]+.[0-9]+(-[a-zA-Z0-9.]+)?$

string
Pattern
"^[0-9]+\\.[0-9]+\\.[0-9]+(-[a-zA-Z0-9.]+)?$"
Minimum length
1
workflowsOptional

Only the fields listed here are accepted.

Read-only values

Show values
idIntegrationDefinitionID!Read only

Unique identifier

computed by the platform

tenantIdTenantID!Read only

Tenant ID

computed by the platform

parentIdIntegrationID!Read only

TypeID of the integration this is a version of (prefix igr). Fixed at creation.

References integration

computed by the platform

integrationIdString!Read only

Integration identifier (e.g., com.acme.erp-connector)

computed by the platform

versionString!Read only

Semantic version (e.g., 1.2.4)

computed by the platform

nativeProjectionJSONRead only

Server-derived native runtime projection compiled from authoritative Integration XML; not an authoring input.

computed by the platform

exportedActions[IntegrationExportedActionDescription!]!Read only

Actions this definition's API clients export (<export>), named client.operation, with JSON Schemas generated from each operation's compiled contract. The schemas describe the Actions for discovery; the contract itself checks every call. Empty for legacy definitions.

computed by the platform

configSchemaStringRead only

JSON Schema document an instance's config must satisfy, compiled from sourceXML (or read from a legacy bundle); null when the definition declares no configuration.

computed by the platform

revisionInt!Read only

Monotonic native draft revision used to reject stale source edits and publication attempts.

computed by the platform

bundleIntegrationBundleRead only

Integration bundle containing manifest and files

computed by the platform

statusIntegrationDefinitionStatus!Read only

Status (DRAFT, ACTIVE or DEPRECATED)

Allowed values

DRAFT — Draft, still being built in the integration builder

ACTIVE — Active and available for installation

DEPRECATED — Deprecated, no new installations allowed

computed by the platform

engineVersionInt!Read only

Runtime version: 3 for native XML definitions; 1 and 2 identify legacy bundles.

computed by the platform

createdAtISO8601!Read only

Creation timestamp (ISO8601)

computed by the platform

exportDocumentStringRead only

Legacy bundle export; native definitions are authored and read back through sourceXML.

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.