Sanity Library Reference Docs
    Preparing search index...
    • Drive a workflow instance reactively from the App SDK store: the instance observes in the engine's state dataset (engine.workflowResource — routinely a dedicated workflows dataset), content docs in their ref's own project/dataset, and guards fan out across the engine dataset plus every watched ref's dataset (a guard co-locates with the subject it locks). Returns the full WorkflowSession (evaluation, ready, guards, and the tick/fireAction/editField/preview verbs); the consumer decides when to advance.

      Parameters

      • __namedParameters: { engine: Engine; grantsFromPath?: string; instanceId: string }
        • engine: Engine
        • OptionalgrantsFromPath?: string

          URL path where the engine client reads the actor's ACL grants, such as /projects/PROJECT_ID/datasets/DATASET/acl or /canvases/CANVAS_ID/acl. Supply it for conditions using $can; omission leaves $can undefined. Grants inform advisory verdicts. Content Lake enforces writes.

        • instanceId: string

      Returns WorkflowSession