@servicenow/sdk - v4.9.0
    Preparing search index...

    Interface PlaybookBodyParams<I, P>

    Params available inside lane activities and execution functions. Provides typed access to playbook inputs.

    Activity output references use local variables (same-lane) or lane variables (cross-lane) rather than a params proxy — see examples.

    interface PlaybookBodyParams<
        I extends Record<string, Column> = Record<string, Column>,
        P extends string | undefined = undefined,
    > {
        inputs: string extends keyof I ? any : PlaybookColumnTypes<I>;
        parentRecord: P extends keyof Tables ? ParentRecordReference<P> : any;
        state: string;
    }

    Type Parameters

    Index

    Properties

    inputs parentRecord state

    Properties

    inputs: string extends keyof I ? any : PlaybookColumnTypes<I>

    References to declared playbook inputs (dot-walkable). When I is specific (from PlaybookDefinition context), provides autocomplete on input names. When I is defaulted (inside wfa.playbook.lane()), falls back to any for dot-walking.

    parentRecord: P extends keyof Tables ? ParentRecordReference<P> : any

    Reference to the parent record (dot-walkable). Available when parentTable is set on PlaybookConfig.

    state: string

    Reference to the playbook's state field (dot-walkable).

    Settings

    Member Visibility

    On This Page

    Properties