← API reference
CANONICAL TYPE REFERENCE

IntegrationManifest

Integration manifest metadata

idString!

Integration identifier

versionString!

Semantic version

sdkVersionString!

SDK version for compatibility

Config schema file path

Resource requirements

permissions[String!]!

Permission requests

Optional description

Optional data container schema definitions

Optional reusable workflow action definitions

Runtime mode (bundle or script actor)

Entrypoint script filename. Unused by the current engine; handlers are inline source on timers and subscriptions.

Optional event subscriptions for script actor mode

Optional timer definitions for script actor mode

Maximum Lua execution time in milliseconds for every script path of this integration. Defaults to 5000ms when nil; capped at 60000ms.

v2 only — inline Lua chunk run once on instance start.

v2 only — inline Lua chunk run once on instance stop.

v2 only — inline Lua chunk run once during an upgrade to this definition. Receives (oldVersion, newVersion, oldConfig) and may return a new config table.

librariesString!

v2 only — reusable Lua snippets keyed by name (JSON-encoded). Loaded on demand by handlers via ctx.script.load(name).

View exact SDL
"""Integration manifest metadata"""
type IntegrationManifest {
  """Integration identifier"""
  id: String!
  """Semantic version"""
  version: String!
  """SDK version for compatibility"""
  sdkVersion: String!
  """Config schema file path"""
  configSchema: String
  """Resource requirements"""
  resources: [ResourceInterface!]!
  """Permission requests"""
  permissions: [String!]!
  """Optional description"""
  description: String
  """Optional data container schema definitions"""
  dataContainerSchemas: [DataContainerSchemaSpec!]
  """Optional reusable workflow action definitions"""
  actions: [IntegrationActionSpec!]
  """Runtime mode (bundle or script actor)"""
  runtimeMode: IntegrationRuntimeMode
  """
  Entrypoint script filename. Unused by the current engine; handlers are inline `source` on timers and subscriptions.
  """
  entryScript: String
  """Optional event subscriptions for script actor mode"""
  subscriptions: [IntegrationEventSubscriptionSpec!]
  """Optional timer definitions for script actor mode"""
  timers: [IntegrationTimerSpec!]
  """
  Maximum Lua execution time in milliseconds for every script path of this integration. Defaults to 5000ms when nil; capped at 60000ms.
  """
  timeoutMs: Int
  """v2 only — inline Lua chunk run once on instance start."""
  initSource: String
  """v2 only — inline Lua chunk run once on instance stop."""
  shutdownSource: String
  """
  v2 only — inline Lua chunk run once during an upgrade to this definition. Receives (oldVersion, newVersion, oldConfig) and may return a new config table.
  """
  upgradeSource: String
  """
  v2 only — reusable Lua snippets keyed by name (JSON-encoded). Loaded on demand by handlers via ctx.script.load(name).
  """
  libraries: String!
}

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