nodes

Class Webhook<L, P>

Source
Expand description

Starts the workflow when a webhook is called

Constructors§

Source§

new Webhook<L extends string, P extends WebhookProps>(
    id: L,
    props: P,
): Webhook<L, P>

Properties§

Source§

public readonly id: L

Unique identifier for this state

Source§

public readonly label: undefined | string

The node label

Source§

public position?: NodePosition

Position of the node in the n8n workflow editor canvas When undefined, the node will be placed automatically

default
undefined
Source§

props: P

Source§

public size: NodeSize = DEFAULT_NODE_SIZE

Size of the node in the n8n workflow editor

default
DEFAULT_NODE_SIZE

Methods§

Source§

canTakeInput(
    _fromState: IChainable,
    _withConnectionOptions?: ConnectionOptions,
): boolean

Determines if this state can accept input from another state

Source§

clone<Id extends string>(
    id: Id,
    props?: NodeProps,
    cloneOptions?: { preserveChainConnections?: boolean },
): Omit<Webhook<L, P>, "id"> & Node<
    Id,
    {
        body: GetOutputSchemaField<P, "body">;
        executionMode: "test" | "production";
        headers: GetOutputSchemaField<P, "headers">;
        params: GetOutputSchemaField<P, "params">;
        query: GetOutputSchemaField<P, "query">;
        webhookUrl: string;
    },
>

Creates a deep copy of this node with a new ID and optional property overrides

Source§

getCredentials(): (
    | undefined
    | Credentials<HttpBasicAuthCredentials>
    | Credentials<HttpHeaderAuthCredentials>
    | Credentials<JwtAuthCredentials>
)[]

Returns the credentials required by this node

Source§

getLabel(): string

Gets the display label for this node

Source§

getParameters(): Promise<undefined | {}>

Retrieves the parameters configured for this node

Source§

getPath(): string

Gets the full path of this node including its parent workflow

Source§

listOutgoing(): IChainable<string, any>[]

Returns all states that are connected as next states from this state

Source§

toCustom(
    type:
        | "ai_tool"
        | "ai_languageModel"
        | "ai_document"
        | "ai_embedding"
        | "ai_memory"
        | "ai_outputParser"
        | "ai_textSplitter"
        | "ai_vectorStore",
    next: IChainable,
): this

Source§

toNode(): Promise<
    {
        alwaysOutputData: undefined
        | boolean;
        credentials:
            | undefined
            | { [type: string]: { id: string } };
        disabled: undefined | boolean;
        executeOnce: undefined | boolean;
        id: L;
        maxTries: undefined | number;
        name: string;
        notes: undefined | string;
        notesInFlow: undefined | boolean;
        onError:
            | undefined
            | "continueRegularOutput"
            | "continueErrorOutput";
        parameters: undefined
        | {};
        position: undefined | NodePosition;
        retryOnFail: undefined | boolean;
        type: string;
        typeVersion: number;
    },
>