Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowInstanceStartedData

    The caller-provenance fields every engine event payload carries: the engine's own view of the host that invoked it. ExecutionContext.id is never reported.

    interface WorkflowInstanceStartedData {
        definitionContentHash?: string;
        executionKind?: ReportedExecutionKind;
        executionRuntime: string;
        initialFieldCount: number;
        instanceId: string;
        lifecycle: WorkflowLifecycle;
        viaSpawn: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    definitionContentHash? executionKind? executionRuntime initialFieldCount instanceId lifecycle viaSpawn

    Properties

    definitionContentHash?: string

    Absent only when the definition predates content fingerprinting.

    executionKind?: ReportedExecutionKind

    Where the operation came from: the host's declared EXECUTION_KINDS value projected onto the reported vocabulary, or other for a kind outside it. Absent when the host declared none.

    executionRuntime: string

    The JavaScript runtime the engine inferred for itself, matching the executionContext.runtime the same operation stamps on its history entries.

    initialFieldCount: number

    Caller-supplied initial-field entries — initialFields for a direct start, the parent's projected with bindings for a spawned child.

    instanceId: string

    The instance document _id — the per-instance join key (engine-minted <tag>.wf-instance.<random>; caller-supplied ids ride verbatim).

    lifecycle: WorkflowLifecycle
    viaSpawn: boolean

    Started by a parent's subworkflow spawn rather than a direct startInstance — automation vs. hands-on at instance creation.

    Settings

    Member Visibility

    On This Page

    Properties