Sanity Library Reference Docs
    Preparing search index...

    External work queued for the handler registered under name. Names are unique within a definition; completed outputs are read as $effects['<name>'].

    bindings resolves GROQ expressions against the action's rendered scope when the effect is queued. The handler receives one parameter bag combining those values with static input. An input key overrides a same-named binding, including when its value is null.

    outputs declares the allowed result keys and their FieldShapes. An undeclared key or invalid value rejects the completion without storing it. Omitting outputs allows no output keys.

    retry (EffectRetry) bounds how many times a failing handler is attempted. Omitting it completes the effect as failed on the first failure.

    interface Effect {
        bindings?: Record<string, string>;
        description?: string;
        input?: Record<string, unknown>;
        name: string;
        outputs?: FieldShape[];
        retry?: EffectRetry;
        title?: string;
    }
    Index

    Properties

    bindings?: Record<string, string>
    description?: string
    input?: Record<string, unknown>
    name: string
    outputs?: FieldShape[]
    retry?: EffectRetry
    title?: string