Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowEffectCompletedData

    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 WorkflowEffectCompletedData {
        cascaded: number;
        definitionContentHash?: string;
        effect: string;
        executionKind?: ReportedExecutionKind;
        executionRuntime: string;
        instanceId: string;
        origin: "action";
        status: EffectRunStatus;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cascaded definitionContentHash? effect executionKind? executionRuntime instanceId origin status

    Properties

    cascaded: number

    Auto-transitions fired during the post-completion cascade — always 0 for a cancellation (the instance is terminal).

    definitionContentHash?: string

    Absent only when the definition predates content fingerprinting.

    effect: string

    The effect's author-chosen name, unique per definition.

    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.

    instanceId: string

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

    origin: "action"

    Which declaration boundary queued the effect.

    status: EffectRunStatus

    The recorded outcome of the effect — cancelled when an abort discarded it rather than a completer reporting.

    Settings

    Member Visibility

    On This Page

    Properties