Sanity Library Reference Docs
    Preparing search index...

    A unit of work carrying no payload of its own — every op, effect, and spawn lives on an action; an activity contributes scoped fields (resolved at stage entry), existence (filter), advisory readiness (requirements), and the off-system marker (target, a BPMN Manual Task deep-link, render-only and never gating). All in-scope activities are ACTIVE from stage entry until an action's terminal status resolves them — there is no activation moment. filter is existence with GROQ semantics, evaluated once against the stage's entry state: a definite false excludes the activity from UI, LLMs, and $allActivitiesDone. requirements are readiness gates orthogonal to filter — an unmet one keeps the activity visible but disables its actions with a requirements-unmet verdict; distinct from ACL and guards.

    interface Activity {
        actions?: Action[];
        description?: string;
        fields?: FieldEntry[];
        filter?: string;
        group?: string[];
        groups?: Group[];
        name: string;
        requirements?: GroqRequirement[];
        semantics?: Semantic[];
        target?: ManualTarget;
        title?: string;
    }
    Index

    Properties

    actions?: Action[]
    description?: string
    fields?: FieldEntry[]
    filter?: string
    group?: string[]
    groups?: Group[]
    name: string
    requirements?: GroqRequirement[]
    semantics?: Semantic[]
    target?: ManualTarget
    title?: string