Interface ExecuteWorkflowProps<Input, Output>

Source
interface ExecuteWorkflowProps<
    Input extends Type,
    Output extends Type,
> {
    alwaysOutputData?: boolean;
    disabled?: boolean;
    executeOnce?: boolean;
    label?: string;
    maxTries?: number;
    notes?: string;
    notesInFlow?: boolean;
    onError?:
        | "continueRegularOutput"
        | "continueErrorOutput";
    parameters: Omit<
        ExecuteWorkflowNodeParameters,
        "workflowInputs"
        | "source"
        | "workflowId",
    > & {
        workflow:
            | Workflow<Input, Output>
            | ImportedWorkflow<Input, Output>;
        workflowInputs:
            | Record<string, unknown>
            | ExpressionOrValue<Input["infer"]>
            | JsonExpression<Input["infer"]>;
    };
    position?: NodePosition;
    retryOnFail?: boolean;
}

Properties§

Source§

alwaysOutputData?: boolean

Source§

disabled?: boolean

If true, the node won't run but subsequent nodes WILL be executed

default
false
Source§

executeOnce?: boolean

If active, the node executes only once, with data from the first item it receives

default
false
Source§

label?: string

Source§

maxTries?: number

Number of times to attempt to execute the node before failing the execution Enabled if retryOnFail is true

default
3
Source§

notes?: string

Optional note to save with the node

default
undefined
Source§

notesInFlow?: boolean

Source§

onError?: "continueRegularOutput" | "continueErrorOutput"

Action to take when the node execution fails When undefined, an error will stop the workflow execution

default
undefined
Source§

parameters: Omit<
    ExecuteWorkflowNodeParameters,
    "workflowInputs"
    | "source"
    | "workflowId",
> & {
    workflow:
        | Workflow<Input, Output>
        | ImportedWorkflow<Input, Output>;
    workflowInputs:
        | Record<string, unknown>
        | ExpressionOrValue<Input["infer"]>
        | JsonExpression<Input["infer"]>;
}

Source§

position?: NodePosition

Source§

retryOnFail?: boolean

If active, the node tries to execute again when it fails

default
false