nodes/generated

Interface ChatTriggerNodeParameters

Source
interface ChatTriggerNodeParameters {
    agentDescription?: string;
    agentIcon?: unknown;
    agentName?: string;
    authentication?: "none" | "basicAuth" | "n8nUserAuth";
    availableInChat?: boolean;
    initialMessages?: string;
    mode?: "hostedChat" | "webhook";
    options?:
        | {
            allowedFilesMimeTypes?: string;
            allowFileUploads?: boolean;
        }
        | {
            allowedFilesMimeTypes?: string;
            allowedOrigins?: string;
            allowFileUploads?: boolean;
            customCss?: string;
            getStarted?: string;
            inputPlaceholder?: string;
            loadPreviousSession?: | "notSupported"
            | "memory"
            | "manually";
            responseMode?: "lastNode"
            | "responseNode";
            showWelcomeScreen?: boolean;
            subtitle?: string;
            title?: string;
        }
        | {
            allowedFilesMimeTypes?: string;
            allowedOrigins?: string;
            allowFileUploads?: boolean;
            customCss?: string;
            getStarted?: string;
            inputPlaceholder?: string;
            loadPreviousSession?: | "notSupported"
            | "memory"
            | "manually";
            responseMode?: | "lastNode"
            | "responseNode"
            | "streaming";
            showWelcomeScreen?: boolean;
            subtitle?: string;
            title?: string;
        }
        | {
            allowedFilesMimeTypes?: string;
            allowFileUploads?: boolean;
            responseMode?: | "lastNode"
            | "streaming"
            | "responseNodes";
        }
        | {
            allowedFilesMimeTypes?: string;
            allowedOrigins?: string;
            allowFileUploads?: boolean;
            customCss?: string;
            getStarted?: string;
            inputPlaceholder?: string;
            loadPreviousSession?: | "notSupported"
            | "memory"
            | "manually";
            responseMode?: | "lastNode"
            | "responseNode"
            | "streaming"
            | "responseNodes";
            showWelcomeScreen?: boolean;
            subtitle?: string;
            title?: string;
        };
    public?: boolean;
    suggestedPrompts?: {
        prompts: { icon?: unknown; text: string }[];
    };
}

Properties§

§readonly agentDescription?: string

The description of the agent on n8n Chat Type options: {"rows":2}

§readonly agentIcon?: unknown

The icon of the agent on n8n Chat Default: {"type":"icon","value":"bot"}

§readonly agentName?: string

The name of the agent on n8n Chat. Name of the workflow is used if left empty.

§readonly authentication?: "none" | "basicAuth" | "n8nUserAuth"

The way to authenticate Default: "none"

§readonly availableInChat?: boolean

Whether to make the agent available in n8n Chat Hub for n8n instance users to chat with

§readonly initialMessages?: string

Default messages shown at the start of the chat, one per line Default: "Hi there! 👋\nMy name is Nathan. How can I assist you today?" Type options: {"rows":3}

§readonly mode?: "hostedChat" | "webhook"

Default: "hostedChat"

§readonly options?:
    | {
        allowedFilesMimeTypes?: string;
        allowFileUploads?: boolean;
    }
    | {
        allowedFilesMimeTypes?: string;
        allowedOrigins?: string;
        allowFileUploads?: boolean;
        customCss?: string;
        getStarted?: string;
        inputPlaceholder?: string;
        loadPreviousSession?: | "notSupported"
        | "memory"
        | "manually";
        responseMode?: "lastNode"
        | "responseNode";
        showWelcomeScreen?: boolean;
        subtitle?: string;
        title?: string;
    }
    | {
        allowedFilesMimeTypes?: string;
        allowedOrigins?: string;
        allowFileUploads?: boolean;
        customCss?: string;
        getStarted?: string;
        inputPlaceholder?: string;
        loadPreviousSession?: | "notSupported"
        | "memory"
        | "manually";
        responseMode?: | "lastNode"
        | "responseNode"
        | "streaming";
        showWelcomeScreen?: boolean;
        subtitle?: string;
        title?: string;
    }
    | {
        allowedFilesMimeTypes?: string;
        allowFileUploads?: boolean;
        responseMode?: | "lastNode"
        | "streaming"
        | "responseNodes";
    }
    | {
        allowedFilesMimeTypes?: string;
        allowedOrigins?: string;
        allowFileUploads?: boolean;
        customCss?: string;
        getStarted?: string;
        inputPlaceholder?: string;
        loadPreviousSession?: | "notSupported"
        | "memory"
        | "manually";
        responseMode?: | "lastNode"
        | "responseNode"
        | "streaming"
        | "responseNodes";
        showWelcomeScreen?: boolean;
        subtitle?: string;
        title?: string;
    }

Default: {}

§readonly public?: boolean

Whether the chat should be publicly available or only accessible through the manual chat interface

§readonly suggestedPrompts?: { ... }

Suggested prompts shown to users in n8n Chat Hub to start a conversation with the agent Default: {} Type options: {"multipleValues":true,"fixedCollection":{"layout":"inline"}}