← API reference
CANONICAL TYPE REFERENCE

WorkflowState

A workflow definition that can have multiple versions

Unique identifier

Tenant ID

nameString!

Workflow name

Workflow description

Currently active version ID

Bot user ID for workflow execution identity

Default timeout for workflow nodes in seconds (null disables default node timeout)

isActiveBoolean!

Whether the workflow is active and can be executed

Creation timestamp (ISO8601)

Last update timestamp (ISO8601)

View exact SDL
"""A workflow definition that can have multiple versions"""
type WorkflowState @iac_resource(name: "workflow") @iac_guide(ref: "workflow-authoring-guide") @iac_ops(create: "createWorkflow", read: "getWorkflow", update: "updateWorkflow", delete: "deleteWorkflow") {
  """Unique identifier"""
  id: WorkflowID! @iac_identity(assignedBy: SERVER) @iac_computed
  """Tenant ID"""
  tenantId: TenantID! @iac_computed
  """Workflow name"""
  name: String!
  """Workflow description"""
  description: String
  """Currently active version ID"""
  currentVersionId: WorkflowVersionID @iac_ref(resource: "workflow_version") @iac_writtenBy(operation: "setActiveVersion", argument: "versionId")
  """Bot user ID for workflow execution identity"""
  botUserId: UserID @iac_ref(resource: "service_account")
  """
  Default timeout for workflow nodes in seconds (null disables default node timeout)
  """
  defaultNodeTimeoutSeconds: Int
  """Whether the workflow is active and can be executed"""
  isActive: Boolean!
  """Creation timestamp (ISO8601)"""
  createdAt: ISO8601! @iac_computed
  """Last update timestamp (ISO8601)"""
  updatedAt: ISO8601! @iac_computed
}

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