Subscription
Fields
Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
Subscribe to committed status transitions. Requires read permission on each requested entity type.
Observe current collaborators and stack revision changes while editing a stack.
Arguments (2)
Stack whose editing presence should be observed.
Editor session associated with this subscription.
Stream new LOG-kind edgeApp events as they arrive for a single installation. Requires edge_app_event:read.
Arguments (1)
Installation to stream LOG-kind events for
Stream real-time training status events for an ML model config.
Arguments (1)
ID of the ML model config to subscribe to
Stream one of your experiment runs: its current state, then its result when it finishes. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (1)
ID of one of your experiment's runs
Stream AI responses for a chat message in real-time. Emits chunks as they arrive. Your own OPS sessions need only a login (one turn at a time); any other session requires chatsession:write permission.
Arguments (2)
Chat session ID to stream messages for
Message content to send
Stream execution log entries as they are written for a given context. Requires integrationInstance:read.
Arguments (2)
Type of execution context (currently only INTEGRATION_INSTANCE is supported)
Possible values (2)
INTEGRATION_INSTANCELog from an integration instance execution
WORKFLOW_EXECUTIONLog from a workflow execution
ID of the execution context (TypeID or UUID)
Stream logs across drains (webhook, execution, edge app) as they are written. Requires log:list permission.
Arguments (1)
Restrict the live stream to these sources (default: all). ARCHIVE is not live-streamed.
Possible values (5)
ENDPOINTIncoming webhook invocation log
EXECUTIONWorkflow script log
INTEGRATIONIntegration script log
EDGE_APPEdge app (IoT controller) log
ARCHIVEArchive export script log line
Stream progress events for a simulation run. The first event reflects the persisted state, so a subscriber joining after the run ended receives its terminal status and the stream finishes. Requires scenarioSimulationRun:read permission.
Arguments (1)
The run to follow
Streams twin transitions as they are recorded — shadow transitions per operation and for the work centre as a whole, and pace-track transitions (STEADY, SLOWING, ENDED) — from the event bus — so a transition recorded by any node reaches the subscriber. Ends at once for a work centre this tenant cannot see, or when the server runs without an event bus. Requires workCenterBehaviorProfile:read permission.
Arguments (2)
The work centre to follow; omit to follow every work centre of the tenant
Only transitions of this track; omit for both
Possible values (2)
SHADOWThe live shadow: what runs on the machine now, judged against its profile
PACEThe pace track: whether the machine's forecast pace has drifted from its own history, judged after each profile refresh
Stream real-time progress events for a schedule optimization run.
Arguments (1)
ID of the optimization run to subscribe to
Referenced by (0)
Exact type SDL
type Subscription {
"""
Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
"""
dataChangeEvents(
"""
List of event topics to subscribe to (e.g., ["job.updated", "job.created"]). Requires read permission on each topic's resource, except task topics, which a signed-in user without it receives for their own tasks only.
"""
topics: [String!]!
): DataChangeEvent! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Subscribe to committed status transitions. Requires read permission on each requested entity type.
"""
statusEvents(
"""Entity types to watch, e.g. ["ORDER", "JOB"]. Requires read on each."""
entityTypes: [String!]!
"""Optional single-entity filter, as a TypeID (e.g. "job_01K…")."""
entityId: String
"""Optional target-state filter, e.g. "DELIVERED"."""
toState: String
): StatusEvent! @topic(names: ["jobs"])
"""
Observe current collaborators and stack revision changes while editing a stack.
"""
iacEditingPresence(
"""Stack whose editing presence should be observed."""
stackId: IaCStackID!
"""Editor session associated with this subscription."""
sessionId: IaCEditingSessionID
): IaCEditingSnapshot! @topic(names: ["admin"])
"""
Stream new LOG-kind edgeApp events as they arrive for a single installation. Requires edge_app_event:read.
"""
edgeAppLogStream(
"""Installation to stream LOG-kind events for"""
installationId: EdgeAppInstallationID!
): EdgeAppEventState! @topic(names: ["devices"])
"""Stream real-time training status events for an ML model config."""
mlModelTrainingStatus(
"""ID of the ML model config to subscribe to"""
configId: MLModelConfigID!
): MLModelTrainingStatusEvent! @topic(names: ["aiml"])
"""
Stream one of your experiment runs: its current state, then its result when it finishes. Requires mlmodelconfig:execute permission and a signed-in user.
"""
mlExperimentRunStatus(
"""ID of one of your experiment's runs"""
runId: MLExperimentRunID!
): MLExperimentRun! @topic(names: ["aiml"])
"""
Stream AI responses for a chat message in real-time. Emits chunks as they arrive. Your own OPS sessions need only a login (one turn at a time); any other session requires chatsession:write permission.
"""
chatMessageStream(
"""Chat session ID to stream messages for"""
sessionId: ChatSessionID!
"""Message content to send"""
content: String!
): ChatSessionStreamChunk! @topic(names: ["aiml"])
"""
Stream execution log entries as they are written for a given context. Requires integrationInstance:read.
"""
executionLogStream(
"""
Type of execution context (currently only INTEGRATION_INSTANCE is supported)
"""
contextType: ExecutionLogContextType!
"""ID of the execution context (TypeID or UUID)"""
contextId: String!
): ExecutionLogState! @topic(names: ["workflows"])
"""
Stream logs across drains (webhook, execution, edge app) as they are written. Requires log:list permission.
"""
streamLogs(
"""
Restrict the live stream to these sources (default: all). ARCHIVE is not live-streamed.
"""
sources: [UnifiedLogSource!]
): UnifiedLogState! @topic(names: ["admin"])
"""
Stream progress events for a simulation run. The first event reflects the persisted state, so a subscriber joining after the run ended receives its terminal status and the stream finishes. Requires scenarioSimulationRun:read permission.
"""
scenarioSimulationProgress(
"""The run to follow"""
runId: ScenarioSimulationRunID!
): SimulationProgressEvent! @topic(names: ["jobs"])
"""
Streams twin transitions as they are recorded — shadow transitions per operation and for the work centre as a whole, and pace-track transitions (STEADY, SLOWING, ENDED) — from the event bus — so a transition recorded by any node reaches the subscriber. Ends at once for a work centre this tenant cannot see, or when the server runs without an event bus. Requires workCenterBehaviorProfile:read permission.
"""
workCenterTwinShadowChanged(
"""
The work centre to follow; omit to follow every work centre of the tenant
"""
workCenterId: WorkCenterID
"""Only transitions of this track; omit for both"""
track: WorkCenterTwinTrack
): WorkCenterTwinEvent! @topic(names: ["jobs"])
"""Stream real-time progress events for a schedule optimization run."""
scheduleOptimizationProgress(
"""ID of the optimization run to subscribe to"""
runId: OptimizationRunID!
): OptimizationProgressEvent! @topic(names: ["jobs"])
}