Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowDefinitionDeployedData

    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 WorkflowDefinitionDeployedData {
        actionCount: number;
        activityCount: number;
        activityKinds: ("user" | "service" | "script" | "manual" | "receive")[];
        contentHash: string;
        deployId: string;
        effectCount: number;
        executionKind?: ReportedExecutionKind;
        executionRuntime: string;
        fieldCount: number;
        fieldKinds: (keyof FieldValueMap)[];
        guardCount: number;
        lifecycle: WorkflowLifecycle;
        stageCount: number;
        status: "unchanged" | "created";
        subworkflowCount: number;
        transitionCount: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionCount activityCount activityKinds contentHash deployId effectCount executionKind? executionRuntime fieldCount fieldKinds guardCount lifecycle stageCount status subworkflowCount transitionCount

    Properties

    actionCount: number
    activityCount: number
    activityKinds: ("user" | "service" | "script" | "manual" | "receive")[]

    Distinct effective activity kinds used, sorted.

    contentHash: string

    Content fingerprint of the deployed content.

    deployId: string

    Groups every definition event minted by one deployDefinitions call — a random run id, never derived from names or resource coordinates, so deployment-level rollups are a group-by without carrying customer strings. Distinct from the workflow-domain deployment tag.

    effectCount: number

    Effects declared across the definition's actions.

    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.

    fieldCount: number

    Declared field entries across workflow, stage, and activity scopes.

    fieldKinds: (keyof FieldValueMap)[]

    Distinct declared field kinds across workflow, stage, and activity scopes, sorted.

    guardCount: number
    lifecycle: WorkflowLifecycle
    stageCount: number
    status: "unchanged" | "created"

    Whether this deploy minted a new version or matched the latest one. Unchanged redeploys emit too — the attempt is the adoption signal.

    subworkflowCount: number

    Actions carrying a spawn block.

    transitionCount: number

    Settings

    Member Visibility

    On This Page

    Properties