nodes/generated

Interface WebhookNodeParameters

Source
interface WebhookNodeParameters {
    authentication?:
        | "none"
        | "basicAuth"
        | "headerAuth"
        | "jwtAuth";
    httpMethod?: | "GET"
    | "POST"
    | "DELETE"
    | "HEAD"
    | "PATCH"
    | "PUT"
    | (
        | "GET"
        | "POST"
        | "DELETE"
        | "HEAD"
        | "PATCH"
        | "PUT"
    )[];
    multipleMethods?: boolean;
    options?: {
        binaryData?: boolean;
        binaryPropertyName?: string;
        ignoreBots?: boolean;
        ipWhitelist?: string;
        noResponseBody?: boolean;
        rawBody?: boolean;
        responseCode?: {
            values: {
                customCode?: number;
                responseCode?: | 200
                | 201
                | 204
                | 301
                | 302
                | 304
                | 400
                | 401
                | 403
                | 404
                | "customCode";
            };
        };
        responseContentType?: string;
        responseData?: string;
        responseHeaders?: {
            entries: { name?: string; value?: string }[];
        };
        responsePropertyName?: string;
    };
    path?: string;
    responseBinaryPropertyName?: string;
    responseCode?: number;
    responseData?: | "noData"
    | "allEntries"
    | "firstEntryJson"
    | "firstEntryBinary";
    responseMode?: | "lastNode"
    | "responseNode"
    | "streaming"
    | "onReceived";
}

Properties§

Source§

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

The way to authenticate Default: "none"

Source§

readonly httpMethod?:
    | "GET"
    | "POST"
    | "DELETE"
    | "HEAD"
    | "PATCH"
    | "PUT"
    | (
        | "GET"
        | "POST"
        | "DELETE"
        | "HEAD"
        | "PATCH"
        | "PUT"
    )[]

The HTTP method to listen to Default: "GET"

Source§

readonly multipleMethods?: boolean

Whether to allow the webhook to listen for multiple HTTP methods

Source§

readonly options?: {
    binaryData?: boolean;
    binaryPropertyName?: string;
    ignoreBots?: boolean;
    ipWhitelist?: string;
    noResponseBody?: boolean;
    rawBody?: boolean;
    responseCode?: {
        values: {
            customCode?: number;
            responseCode?:
                | 200
                | 201
                | 204
                | 301
                | 302
                | 304
                | 400
                | 401
                | 403
                | 404
                | "customCode";
        };
    };
    responseContentType?: string;
    responseData?: string;
    responseHeaders?: {
        entries: { name?: string; value?: string }[];
    };
    responsePropertyName?: string;
}

Default: {}

Source§

readonly path?: string

The path to listen to, dynamic values could be specified by using ':', e.g. 'your-path/:dynamic-value'. If dynamic values are set 'webhookId' would be prepended to path.

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" | "streaming" | "onReceived"

When and how to respond to the webhook Default: "onReceived"