Sanity Library Reference Docs
    Preparing search index...

    Type Alias WorkflowOperationRequest

    WorkflowOperationRequest: {
        executionContext?: DeclaredExecutionContext;
        partition: string;
        protocolVersion: 1;
        workflowResource: WorkflowResource;
    } & (
        | {
            args: StartInstanceArgs & { instanceId: string };
            verb: "startInstance";
        }
        | { args: FireActionArgs; verb: "fireAction" }
        | { args: EditFieldArgs; verb: "editField" }
        | { args: AbortInstanceArgs; verb: "abortInstance" }
        | { args: OperationArgs; verb: "tick" }
    )

    One operation for a Workflows service to run, in operation protocol version

    1. It is posted to /workflow/operation on the API host of the sending client. args are the verb's own arguments, unchanged; PROTOCOL.md in this package lists how the service treats each member.

    Type declaration

    • OptionalexecutionContext?: DeclaredExecutionContext

      The sender's declared execution context. The service uses it for telemetry only.

    • partition: string

      The engine's partition.

    • protocolVersion: 1
    • workflowResource: WorkflowResource

      The resource holding the workflow's documents, as the engine was created with.