Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowEffectCompletedData

    interface WorkflowEffectCompletedData {
        cascaded: number;
        definitionContentHash?: string;
        effect: string;
        instanceId: string;
        origin: "action";
        status: EffectRunStatus;
    }

    Hierarchy

    • InstanceScopedEventData
      • WorkflowEffectCompletedData
    Index

    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 — one of the payload policy's two deliberate customer-string exceptions (module doc); unique per definition.

    instanceId: string

    The instance document _id — the per-instance join key (engine-minted <tag>.wf-instance.<random>; caller-supplied ids ride verbatim). One of the payload policy's two deliberate customer-string exceptions — see the module doc.

    origin: "action"

    Which declaration boundary queued the effect.

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