Sanity Library Reference Docs
    Preparing search index...

    The authoring surface: stored primitives plus the define-time sugar. runtime says where the generated unattended runtime hosts this workflow, overriding its deployment's kind; an effect node overrides it in turn.

    interface AuthoringWorkflow {
        description?: string;
        fields?: AuthoringFieldEntry[];
        groups?: Group[];
        initialStage: string;
        lifecycle?: WorkflowLifecycle;
        name: string;
        predicates?: Record<string, string>;
        roleAliases?: RoleAliases;
        runtime?: RuntimeBlock;
        semantics?: Semantic[];
        stages: AuthoringStage[];
        start?: AuthoringStartBlock;
        title: string;
    }
    Index

    Properties

    description?: string
    groups?: Group[]
    initialStage: string
    lifecycle?: WorkflowLifecycle
    name: string
    predicates?: Record<string, string>
    roleAliases?: RoleAliases
    runtime?: RuntimeBlock
    semantics?: Semantic[]
    stages: AuthoringStage[]
    title: string