Sanity Library Reference Docs
    Preparing search index...

    Interface BlueprintScheduledFunctionConfig

    Configuration for defining a scheduled function.

    interface BlueprintScheduledFunctionConfig {
        displayName?: string;
        env?: Record<string, string>;
        event: BlueprintScheduledFunctionConfigEvent;
        memory?: number;
        name: string;
        robotToken?: string;
        runtime?: "node" | "nodejs22.x" | "nodejs24.x";
        src?: string;
        timeout?: number;
        timezone?: IanaTimezone;
    }
    Index

    Properties

    displayName? env? event memory? name robotToken? runtime? src? timeout? timezone?

    Properties

    displayName?: string

    Human-readable display name for the function

    env?: Record<string, string>

    Environment variables provided to the function

    event: BlueprintScheduledFunctionConfigEvent

    Event configuration specifying when the function is triggered

    memory?: number

    Memory allocation in gigabytes

    name: string

    The name of the resource. Unique within the blueprint. e.g. 'sync-webhook'

    robotToken?: string

    Token provided during function invocation

    runtime?: "node" | "nodejs22.x" | "nodejs24.x"

    The runtime environment for the function (currently only Node.js is supported)

    'nodejs24.x'
    src?: string

    Path to the function source code

    functions/${name}

    timeout?: number

    Execution timeout in seconds

    timezone?: IanaTimezone

    Settings

    Member Visibility

    On This Page

    Properties