Interface WebhookProps

interface WebhookProps {
    alwaysOutputData?: boolean;
    disabled?: boolean;
    executeOnce?: boolean;
    label?: string;
    maxTries?: number;
    notes?: string;
    notesInFlow?: boolean;
    onError?:
        | "continueRegularOutput"
        | "continueErrorOutput";
    outputSchema?: {
        body?: Type<unknown, {}>;
        headers?: Type<unknown, {}>;
        params?: Type<unknown, {}>;
        query?: Type<unknown, {}>;
    };
    parameters: WebhookBaseProps;
    position?: NodePosition;
    retryOnFail?: boolean;
}

Properties§

alwaysOutputData?: boolean

disabled?: boolean

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

default

false

executeOnce?: boolean

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

default

false

label?: string

maxTries?: number

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

default

notes?: string

Optional note to save with the node

default

undefined

notesInFlow?: boolean

onError?: "continueRegularOutput" | "continueErrorOutput"

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

default

undefined

outputSchema?: {
    body?: Type<unknown, {}>;
    headers?: Type<unknown, {}>;
    params?: Type<unknown, {}>;
    query?: Type<unknown, {}>;
}

parameters: WebhookBaseProps

position?: NodePosition

retryOnFail?: boolean

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

default

false