nodes/generated

Interface RespondToWebhookNodeParameters

Source
interface RespondToWebhookNodeParameters {
    enableResponseOutput?: boolean;
    inputFieldName?: string;
    options?: {
        enableStreaming?: boolean;
        responseCode?: number;
        responseHeaders?: {
            entries: { name?: string; value?: string }[];
        };
        responseKey?: string;
    };
    payload?: string;
    redirectURL?: string;
    respondWith?: | "json"
    | "binary"
    | "text"
    | "redirect"
    | "jwt"
    | "allIncomingItems"
    | "firstIncomingItem"
    | "noData";
    responseBody?: string;
    responseDataSource?: "set"
    | "automatically";
}

Properties§

Source§

readonly enableResponseOutput?: boolean

Whether to provide an additional output branch with the response sent to the webhook

Source§

readonly inputFieldName?: string

The name of the node input field with the binary data Default: "data"

Source§

readonly options?: {
    enableStreaming?: boolean;
    responseCode?: number;
    responseHeaders?: {
        entries: { name?: string; value?: string }[];
    };
    responseKey?: string;
}

Default: {}

Source§

readonly payload?: string

The payload to include in the JWT token Default: "{\n "myField": "value"\n}" Type options: {"rows":4}

Source§

readonly redirectURL?: string

The URL to redirect to

Source§

readonly respondWith?:
    | "json"
    | "binary"
    | "text"
    | "redirect"
    | "jwt"
    | "allIncomingItems"
    | "firstIncomingItem"
    | "noData"

The data that should be returned Default: "firstIncomingItem"

Source§

readonly responseBody?: string

The HTTP response JSON data Default: "{\n "myField": "value"\n}" Type options: {"rows":4}

Source§

readonly responseDataSource?: "set" | "automatically"

Default: "automatically"