Type Alias PlaybookBodyParams<I, P, E, V>

PlaybookBodyParams: E extends "on_demand"
    ? {
        inputs: string extends keyof I ? any : PlaybookColumnTypes<I>;
        state: string;
        variants: string extends keyof V
            ? any
            : { readonly [K in keyof V]: VariantReference };
    }
    : {
        inputs: string extends keyof I ? any : PlaybookColumnTypes<I>;
        parentRecord: P extends TableName
            ? ParentRecordReference<P>
            : DataReference | undefined;
        state: string;
        variants: string extends keyof V
            ? any
            : { readonly [K in keyof V]: VariantReference };
    }

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.

On-demand playbooks (executionType E is 'on_demand') have no triggering record, so parentRecord is omitted entirely — referencing params.parentRecord is a type error.

Type Parameters

I extends Record<string, Column> = Record<string, Column>
P extends string | undefined = undefined
E extends string | undefined = undefined
V extends Record<string, VariantDefinition> = Record<string, VariantDefinition>

Type Alias PlaybookBodyParams<I, P, E, V>

Type Parameters

Settings