Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowActionFiredData

    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 WorkflowActionFiredData {
        activityKind?: "user" | "service" | "script" | "manual" | "receive";
        cascaded: number;
        definitionContentHash?: string;
        executionKind?: ReportedExecutionKind;
        executionRuntime: string;
        hasParams: boolean;
        instanceId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activityKind? cascaded definitionContentHash? executionKind? executionRuntime hasParams instanceId

    Properties

    activityKind?: "user" | "service" | "script" | "manual" | "receive"

    Effective kind of the activity the action fired on.

    cascaded: number

    Auto-transitions fired during the post-action cascade.

    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.

    hasParams: boolean
    instanceId: string

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

    Settings

    Member Visibility

    On This Page

    Properties