nodes/generated

Interface WaitNodeParameters

Source
interface WaitNodeParameters {
    amount?: number;
    dateTime?: string;
    formDescription?: string;
    formFields?: {
        values: {
            acceptFileTypes?: string;
            elementName?: string;
            fieldLabel: string;
            fieldName?: string;
            fieldOptions: { values: { option?: string }[] };
            fieldType:
                | "number"
                | "file"
                | "text"
                | "email"
                | "date"
                | "html"
                | "checkbox"
                | "dropdown"
                | "hiddenField"
                | "password"
                | "radio"
                | "textarea";
            fieldValue?: string;
            formatDate?: string;
            html?: string;
            limitSelection?: "exact"
            | "range"
            | "unlimited";
            maxSelections?: number;
            minSelections?: number;
            multipleFiles?: boolean;
            multiselect?: boolean;
            multiselectLegacyNotice?: string;
            numberOfSelections?: number;
            placeholder?: string;
            requiredField?: boolean;
        }[];
    };
    formTitle?: string;
    httpMethod?: | "GET"
    | "POST"
    | "DELETE"
    | "HEAD"
    | "PATCH"
    | "PUT";
    incomingAuthentication?: | "none"
    | "basicAuth"
    | "headerAuth"
    | "jwtAuth";
    limitType?: "afterTimeInterval"
    | "atSpecifiedTime";
    limitWaitTime?: boolean;
    maxDateAndTime?: string;
    options?:
        | {
            binaryData?: boolean;
            binaryPropertyName?: string;
            ignoreBots?: boolean;
            ipWhitelist?: string;
            noResponseBody?: boolean;
            rawBody?: boolean;
            responseContentType?: string;
            responseData?: string;
            responseHeaders?: {
                entries: { name?: string; value?: string }[];
            };
            responsePropertyName?: string;
            webhookSuffix?: string;
        }
        | {
            appendAttribution?: boolean;
            respondWithOptions?: {
                values: {
                    formSubmittedText?: string;
                    redirectUrl?: string;
                    respondWith?: "text"
                    | "redirect";
                };
            };
            webhookSuffix?: string;
        }
        | {
            appendAttribution?: boolean;
            webhookSuffix?: string;
        };
    responseBinaryPropertyName?: string;
    responseCode?: number;
    responseData?: | "noData"
    | "allEntries"
    | "firstEntryJson"
    | "firstEntryBinary";
    responseMode?: | "lastNode"
    | "responseNode"
    | "onReceived";
    resume?: | "webhook"
    | "form"
    | "timeInterval"
    | "specificTime";
    resumeAmount?: number;
    resumeUnit?: "minutes"
    | "hours"
    | "days"
    | "seconds";
    unit?: "minutes" | "hours" | "days" | "seconds";
}

Properties§

Source§

readonly amount?: number

The time to wait Default: 1 Type options: {"minValue":0,"numberPrecision":2}

Source§

readonly dateTime?: string

The date and time to wait for before continuing

Source§

readonly formDescription?: string

Shown underneath the Form Title. Can be used to prompt the user on how to complete the form. Accepts HTML. Type options: {"rows":2}

Source§

readonly formFields?: {
    values: {
        acceptFileTypes?: string;
        elementName?: string;
        fieldLabel: string;
        fieldName?: string;
        fieldOptions: { values: { option?: string }[] };
        fieldType:
            | "number"
            | "file"
            | "text"
            | "email"
            | "date"
            | "html"
            | "checkbox"
            | "dropdown"
            | "hiddenField"
            | "password"
            | "radio"
            | "textarea";
        fieldValue?: string;
        formatDate?: string;
        html?: string;
        limitSelection?: "exact"
        | "range"
        | "unlimited";
        maxSelections?: number;
        minSelections?: number;
        multipleFiles?: boolean;
        multiselect?: boolean;
        multiselectLegacyNotice?: string;
        numberOfSelections?: number;
        placeholder?: string;
        requiredField?: boolean;
    }[];
}

Default: {} Type options: {"multipleValues":true,"sortable":true}

Source§

readonly formTitle?: string

Shown at the top of the form

Source§

readonly httpMethod?: "GET" | "POST" | "DELETE" | "HEAD" | "PATCH" | "PUT"

The HTTP method of the Webhook call Default: "GET"

Source§

readonly incomingAuthentication?: "none" | "basicAuth" | "headerAuth" | "jwtAuth"

If and how incoming resume-webhook-requests to $execution.resumeFormUrl should be authenticated for additional security Default: "none"

Source§

readonly limitType?: "afterTimeInterval" | "atSpecifiedTime"

Sets the condition for the execution to resume. Can be a specified date or after some time. Default: "afterTimeInterval"

Source§

readonly limitWaitTime?: boolean

Whether to limit the time this node should wait for a user response before execution resumes

Source§

readonly maxDateAndTime?: string

Continue execution after the specified date and time

Source§

readonly options?:
    | {
        binaryData?: boolean;
        binaryPropertyName?: string;
        ignoreBots?: boolean;
        ipWhitelist?: string;
        noResponseBody?: boolean;
        rawBody?: boolean;
        responseContentType?: string;
        responseData?: string;
        responseHeaders?: {
            entries: { name?: string; value?: string }[];
        };
        responsePropertyName?: string;
        webhookSuffix?: string;
    }
    | {
        appendAttribution?: boolean;
        respondWithOptions?: {
            values: {
                formSubmittedText?: string;
                redirectUrl?: string;
                respondWith?: "text"
                | "redirect";
            };
        };
        webhookSuffix?: string;
    }
    | {
        appendAttribution?: boolean;
        webhookSuffix?: string;
    }

Default: {}

Source§

readonly responseBinaryPropertyName?: string

Name of the binary property to return Default: "data"

Source§

readonly responseCode?: number

The HTTP Response code to return Default: 200 Type options: {"minValue":100,"maxValue":599}

Source§

readonly responseData?:
    | "noData"
    | "allEntries"
    | "firstEntryJson"
    | "firstEntryBinary"

What data should be returned. If it should return all items as an array or only the first item as object. Default: "firstEntryJson"

Source§

readonly responseMode?: "lastNode" | "responseNode" | "onReceived"

When to respond to the form submission Default: "onReceived"

Source§

readonly resume?: "webhook" | "form" | "timeInterval" | "specificTime"

Determines the waiting mode to use before the workflow continues Default: "timeInterval"

Source§

readonly resumeAmount?: number

The time to wait Default: 1 Type options: {"minValue":0,"numberPrecision":2}

Source§

readonly resumeUnit?: "minutes" | "hours" | "days" | "seconds"

Unit of the interval value Default: "hours"

Source§

readonly unit?: "minutes" | "hours" | "days" | "seconds"

The time unit of the Wait Amount value Default: "hours"