n8n

https://github.com/synaptiv-ai/awesome-n8n
Admin
Awesome n8n is a community-driven knowledge base for world-class n8n workflows and resources,...
Tokens:1,068
Snippets:1
Trust Score:4.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Repository Setup and Dependencies

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Steps to clone the n8n repository, install dependencies, build the project, and start the application.

```bash
git clone https://github.com/<your-organization>/n8n.git n8n
cd n8n
npm install
npm run build
npm run start
```

--------------------------------

### n8n Quickstart and Tutorials

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Links to n8n quickstart guides and tutorials for getting started with building workflows, including an AI workflow example.

```APIDOC
Try It Out:
- A very quick quickstart
- A longer introduction
- Build an AI workflow in n8n
```

--------------------------------

### n8n Installation Methods

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up n8n, including options for Docker and npm installations, and links to further setup guides.

```APIDOC
Set Up Your n8n:
1. Sign up for a free trial on n8n Cloud or install n8n's community edition.
   - Docker: Refer to Docker Installation documentation.
   - npm: Refer to npm Installation documentation.
2. For further details, see Choose Your n8n.
```

--------------------------------

### Brevo Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Details the setup for Brevo credentials in n8n, focusing on API key authentication. It outlines the prerequisite of a Brevo developer account and directs users to the Brevo API Quick Start documentation for API key generation.

```Markdown
# Brevo Credentials

You can use these credentials to authenticate the following nodes:

- Brevo node
- Brevo Trigger node

## Prerequisites

Create a Brevo developer account.

## Supported Authentication Methods

- API key

## API Key

To configure this credential, you'll need:

- An **API Key**: Refer to the Brevo API Quick Start documentation for instructions on creating a new API key.
```

--------------------------------

### Pinecone API Key Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions to obtain an API key from the Pinecone console and enter it into n8n credentials. It guides users through selecting a project, navigating to API Keys, and copying the key.

```markdown
### Steps to Obtain an API Key:
1. Open your Pinecone console.
2. Select the project you want to create an API key for. If you don't have any existing projects, create one.
3. Go to **API Keys**.
4. Copy the API Key displayed there and enter it in your n8n credential.

Refer to Pinecone's API authentication documentation for more information.
```

--------------------------------

### Starting n8n after npm Installation

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Commands to start the n8n service after it has been installed globally via npm.

```bash
n8n
# or
n8n start
```

--------------------------------

### Discord Bot Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Steps to create a Discord bot, including generating a token, setting up intents, and configuring installation contexts and scopes. It also details adding necessary bot permissions and inviting the bot to a server.

```APIDOC
Discord Bot Setup:

1. Create an app in the developer portal.
2. Name the app and select 'Create'.
3. Navigate to 'Bot' from the left menu.
4. Under 'Token', select 'Reset Token' to generate a new bot token.
5. Copy the token and add it to your n8n credential.
6. In 'Bot > Privileged Gateway Intents', add necessary intents (e.g., SERVER MEMBERS INTENT).
7. In 'Installation > Installation Contexts', select 'Guild Install' or 'User Install'.
8. In 'Installation > Install Link', ensure 'Discord Provided Link' is selected.
9. In 'Default Install Settings', select 'applications.commands' and 'bot' scopes.
10. Add permissions on the 'Bot > Bot Permissions' page (e.g., Manage Roles, Manage Channels, Read Messages/View Channels, Send Messages).
11. Add the app to your server by copying the link from 'Installation > Install Link', pasting it in a browser, and selecting 'Add to server'.
```

--------------------------------

### n8n Start Command

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Command to start the n8n application after installation or linking custom nodes.

```bash
n8n start
```

--------------------------------

### Hetzner Cloud Server Setup and Docker Compose

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Commands for setting up a server on Hetzner Cloud with Docker CE, installing Docker Compose, cloning the n8n-docker-caddy repository, creating Docker volumes, and configuring firewall rules.

```bash
apt update && apt -y upgrade
apt install docker-compose-plugin
git clone https://github.com/n8n-io/n8n-docker-caddy.git
cd n8n-docker-caddy
docker volume create caddy_data
sudo docker volume create n8n_data
sudo ufw allow 80
sudo ufw allow 443
```

--------------------------------

### WordPress Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users on configuring WordPress credentials for n8n, focusing on Basic Auth. It outlines prerequisites, steps for enabling two-step authentication, creating application passwords, and entering the necessary details into n8n.

```Markdown
## Prerequisites
- Create a WordPress account or deploy WordPress on a server.

## Supported Authentication Methods
- Basic auth

## Using Basic Auth

To configure this credential, you'll need:
- Your WordPress **Username**
- A WordPress application **Password**
- Your **WordPress URL**
- Decide whether to **Ignore SSL Issues**

### Steps for Configuration
1. **Enable Two-Step Authentication**
   - Open your WordPress profile.
   - Select **Security** from the left menu.
   - Select **Two-Step Authentication**.
   - If not enabled, enable it using an authenticator app or SMS codes.

2. **Create an Application Password**
   - From the WordPress **Security > Two-Step Authentication** page, select **+ Add new application password** in the **Application passwords** section.
   - Enter an **Application name**, like `n8n integration`.
   - Select **Generate Password**.
   - Copy the generated password for use in your n8n credential.

3. **Set Up the Credential**
   - Enter your WordPress **Username** in your n8n credential.
   - Enter the application password as the **Password** in your n8n credential.
   - Enter the URL of your WordPress site as the **WordPress URL**.
   - Optional: Choose whether you want to ignore SSL certificate validation.
```

--------------------------------

### Onfleet Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Outlines the process for setting up Onfleet credentials using an API key. It guides users on creating an administrator account and generating a new API key through the Onfleet settings.

```APIDOC
Onfleet Credentials:

Supported Authentication Methods:
  - API key

Using API Key:
  - API key: Create a new key via Settings > API & Webhooks in the Onfleet administrator account.
    - Refer to Onfleet's documentation for creating API keys.
```

--------------------------------

### Wasabi Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide to setting up n8n credentials for Wasabi cloud storage. It details how to get the service URL, region, and access keys from the Wasabi Console.

```APIDOC
Wasabi Configuration:
  S3 Endpoint: https://<your-service-url>
  Region: <region-slug-from-url>
  Access Key ID: <Generated Wasabi Access Key>
  Secret Access Key: <Generated Wasabi Secret Key>
  Force Path Style: Enabled (Recommended by Wasabi)
  Ignore SSL Issues: (Optional) Set based on SSL validation preference.
```

--------------------------------

### Box Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users on setting up Box credentials for n8n, supporting OAuth2 authentication. It details the process for n8n Cloud users and instructions for creating a Custom App for OAuth2 configuration, referencing the Box developer documentation.

```Markdown
# Box Credentials

## Supported Nodes
- Box
- Box Trigger

## Prerequisites
- Create a Box account.

## Supported Authentication Methods
- OAuth2

## Using OAuth2
For n8n Cloud users:  
- Select **Connect my account** to connect through your browser.

To configure OAuth2 from scratch, create a Custom App. Refer to the [Box OAuth2 Setup documentation](https://developer.box.com/guides/authentication/oauth2/oauth2-setup/) for additional details.
```

--------------------------------

### n8n SAML Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Overview of SAML feature availability in n8n (Enterprise plans) and links to setup instructions for general configuration, Okta, troubleshooting, and user management.

```APIDOC
SAML Setup Instructions:
- **Set up SAML**: General guide for configuring SAML in n8n with links to resources for common Identity Providers (IdPs).
- **Okta Workforce Identity SAML setup**: Step-by-step guidance to configuring Okta.
- **Troubleshooting**: Checklist for common issues that may arise during SAML setup.
- **Managing users with SAML**: Instructions for performing user management tasks with SAML enabled.
```

--------------------------------

### Todoist Credentials Setup (API Key)

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users on how to set up Todoist credentials using an API Key, including steps to retrieve the API token from Todoist integration settings.

```APIDOC
Todoist Credentials (API Key):
  API Key: Obtain from Todoist Integration settings > Developer tab > API token.
```

--------------------------------

### n8n Docker Installation

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Installs and runs the n8n Docker container, creating a persistent volume for data and mapping the default port 5678 for access. This is the basic setup for running n8n.

```bash
docker volume create n8n_data
docker run -it --rm --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n
```

--------------------------------

### DeepSeek Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide to configuring DeepSeek credentials in n8n. Users need a DeepSeek account and an API key generated from their account's API keys page.

```Markdown
# DeepSeek Credentials

You can use these credentials to authenticate the following nodes:

- Chat DeepSeek

## Prerequisites

- Create a DeepSeek account.

## Supported Authentication Methods

- API key

## Configuration Instructions

To configure this credential, you'll need:

- An **API Key**

To generate your API Key:

1. Login to your DeepSeek account or create an account.
2. Open your API keys page.
3. Select **Create new secret key** to create an API key, optionally naming the key.
4. Copy your key and add it as the **API Key** in n8n.

Refer to DeepSeek's API documentation for more information about the service.
```

--------------------------------

### Microsoft OAuth2 Authentication Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users through setting up OAuth2 authentication for Microsoft services in n8n, including registering an application, generating a client secret, and configuring callback URLs.

```APIDOC
Microsoft OAuth2 Authentication:
  Prerequisites:
    - Microsoft Azure account and user account with appropriate access.
    - For corporate accounts, administrator must enable 'User can consent to apps accessing company data on their behalf'.
  n8n Cloud:
    - Select 'Connect my account' to authenticate via browser.
  Self-hosted:
    1. Register an application with Microsoft Identity Platform.
    2. Generate a client secret for the application.

  Register an Application:
    1. Go to Microsoft Application Registration Portal (aka.ms/appregistrations).
    2. Select 'Register an application'.
    3. Enter an application Name.
    4. Supported account types: 'Accounts in any organizational directory (Any Azure AD directory - Multi-tenant)' and 'personal Microsoft accounts'.
    5. Copy n8n's OAuth Callback URL and paste it into the 'Redirect URI (optional)' field (Platform: Web).
    6. Select 'Register'.
    7. Copy the 'Application (client) ID' to n8n as 'Client ID'.

  Generate a Client Secret:
    1. On the Microsoft application page, go to 'Certificates & secrets'.
    2. Under 'Client secrets', select '+ New client secret'.
    3. Enter a Description and select 'Add'.
    4. Copy the 'Secret' Value to n8n as 'Client Secret'.
    5. Complete other n8n fields and select 'Connect my account'.
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Installs the necessary dependencies for the n8n node project.

```bash
npm i
```

--------------------------------

### Start Docker Compose

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Command to start n8n and Caddy services using Docker Compose.

```bash
sudo docker compose up -d
```

--------------------------------

### n8n Workflow Fundamentals

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

An overview of n8n workflows, including creation, using templates, understanding key components, debugging with the executions list, and sharing workflows. Recommends quickstart guides for new users.

```APIDOC
Workflow Creation:
- Create a workflow.
- Use workflow templates to help you get started.
- Learn about the key components of an automation in n8n.
- Debug using the executions list.
- Share workflows between users.

Best Practices:
- For new users, consider using the quickstart guides to quickly try out n8n features.
```

--------------------------------

### Webflow Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users on setting up Webflow credentials using either an API Access Token or OAuth2. It outlines prerequisites like creating a Webflow account and site, and details the steps for obtaining tokens and configuring the n8n credential.

```APIDOC
Webflow Credentials:
  Supported Authentication Methods:
    - API access token
    - OAuth2

  Using API Access Token:
    Requires a Site Access Token obtained from Webflow Site Settings > Apps & integrations > API access.

  Using OAuth2:
    For cloud users, connect via account. For self-hosted, register an application in your workspace, use the n8n OAuth callback URL as a Redirect URI, and enter the Client ID and Client Secret into n8n.
    Optional: Enable Legacy toggle for Webflow Data API V1.
```

--------------------------------

### Salesmate API Token Authentication Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide for configuring Salesmate credentials in n8n using an API token. Requires a Salesmate account and generating an access key.

```APIDOC
Salesmate API Token Authentication:
  Session Token: Access Key from Salesmate (My Account > Access Key)
  URL: Salesmate domain name/base URL (e.g., n8n.salesmate.io)
```

--------------------------------

### Wise Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Outlines the setup for Wise credentials, which supports API token authentication. Users need to create a Wise account and obtain an API token.

```APIDOC
Wise Credentials:
  Supported Authentication Methods:
    - API token

  Using API Token:
    Requires creating a Wise account and obtaining an API token.
```

--------------------------------

### Start Redis with Docker

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Starts a Redis instance in a Docker container, making it available for n8n's queue mode.

```bash
docker run --name some-redis -p 6379:6379 -d redis
```

--------------------------------

### Local n8n Node Testing Commands (Bash)

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Provides bash commands for installing n8n globally, building and linking the custom node locally, and starting the n8n instance to test the node.

```bash
npm install n8n -g

npm run build
npm link

npm link <node-package-name>

n8n start
```

--------------------------------

### SearXNG API URL Authentication Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up SearXNG credentials in n8n using its API URL.

```APIDOC
SearXNG API URL Authentication:
  API URL: The base URL for the SearXNG instance.
```

--------------------------------

### Install Docker and Docker Compose on Ubuntu

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Detailed bash commands for installing Docker CE, Docker CE CLI, containerd.io, docker-buildx-plugin, and docker-compose-plugin on Ubuntu systems.

```bash
# Remove incompatible or out-of-date Docker implementations
for pkg in docker.io docker-doc docker-compose docker-compose-v2 podman-docker containerd runc; do sudo apt-get remove $pkg; done
# Install prerequisite packages
sudo apt-get update
sudo apt-get install ca-certificates curl
# Download the repo signing key
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc
# Configure the repository
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
# Update and install Docker and Docker Compose
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```

--------------------------------

### Install project dependencies

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Installs all necessary Node.js packages required for the n8n node project, as defined in the package.json file.

```bash
npm i
```

--------------------------------

### Start n8n Webhook Processor

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Starts the n8n webhook processor in queue mode, essential for handling incoming webhooks when scaling.

```bash
./packages/cli/bin/n8n webhook
```

```bash
docker run --name n8n-queue -p 5679:5678 -e "EXECUTIONS_MODE=queue" docker.n8n.io/n8nio/n8n webhook
```

--------------------------------

### Install n8n and Publish Local Node

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Steps to install n8n globally using npm, build your custom node, and link it locally to your n8n instance.

```bash
npm install n8n -g
```

```bash
# In your node directory
npm run build
npm link
```

```bash
# In the nodes directory within your n8n installation
# node-package-name is the name from the package.json
npm link <node-package-name>
```

--------------------------------

### Install n8n globally

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Installs the n8n command-line interface globally on your system, allowing you to run n8n commands from any directory.

```bash
npm install n8n -g
```

--------------------------------

### Installing and Updating n8n Globally with npm

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for installing n8n globally using npm. Covers installing the latest version, a specific version, the 'next' (beta) version, and updating to the latest release.

```bash
# Install Globally with npm
npm install n8n -g
# Install or update to a specific version
npm install -g n8n@0.126.1
# Install the 'next' version
npm install -g n8n@next
# Update to the latest version
npm update -g n8n
# Install the 'next' version
npm install -g n8n@next
```

--------------------------------

### n8n Node Linter Setup and Usage

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up and using the n8n node linter (`eslint-plugin-n8n-nodes-base`) for static code analysis and automatic fixing of n8n node source code. Covers installation, IDE integration, and manual execution commands.

```apidoc
n8n Node Linter (`eslint-plugin-n8n-nodes-base`)

Description:
Statically analyzes n8n node source code to detect and fix issues, ensuring adherence to best practices. Supports node files (`*.node.ts`), resource description files (`*Description.ts`), credential files (`*.credentials.ts`), and `package.json`.

Setup:
1. If using the n8n node starter: Run `npm install`.
2. For VS Code: Install the ESLint extension.

Configuration:
Do not edit the `.eslintrc.js` file.

Usage:
- Automatic linting: Runs after dependency installation and before npm publishing (community packages), or via GitHub Actions (main repository).
- Manual Execution:
  - `npm run lint`: Lints and displays issues in the console.
  - `npm run lintfix`: Lints and automatically fixes fixable issues.
  (Execute in the root directory of the community package or `/packages/nodes-base/` in the main repository).

Exceptions:
- VS Code: Use 'Quick fix' (cmd+.) to 'Disable {rule} for this line'.
- Single file: Add a code comment as per TSLint documentation.
```

--------------------------------

### Dynamic Credential Setup (n8n)

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Demonstrates how to dynamically set credentials in n8n using expressions. This example shows how to capture user input from a form and use it to configure the API key for a NASA node.

```javascript
{{ $json["Enter your NASA API key"] }}
```

--------------------------------

### Install Community Node via npm (GUI)

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for installing a community node from npm using the n8n graphical user interface. This involves navigating to the Community Nodes settings, searching for the desired node package, and installing it.

```text
1. Go to **Settings** > **Community Nodes**.
2. Select **Install**.
3. Find the node you want to install by selecting **Browse**.
4. Enter the npm package name (e.g., `n8n-node-storms`) and optionally a version number (e.g., `n8n-node-storms@2.3`).
5. Agree to the risks and select **Install**.
```

--------------------------------

### Perplexity API Key Configuration

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide for configuring Perplexity credentials with an API key. Users must create a Perplexity account and follow the getting started guide to generate an API key.

```APIDOC
Perplexity API Key:
  - Configuration: Obtain a Perplexity API key by following the Perplexity API getting started guide.
  - Refer to: https://docs.perplexity.ai/api-reference/
```

--------------------------------

### Quick Base Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Configures Quick Base credentials using an API key. Requires a Quick Base account and generation of a user token.

```APIDOC
Quick Base Credentials:
  Supported Nodes: Quick Base
  Authentication Method: API Key
  Prerequisites:
    - Quick Base account
  Configuration:
    - Hostname: Part of the Quick Base URL between 'https://' and '/db'
    - User Token: Generated via Profile > My preferences > My User Information > Manage my user tokens (refer to https://helpv2.quickbase.com/hc/en-us/articles/4570374095124-Creating-and-using-user-tokens)
```

--------------------------------

### Enable Multi-Main Setup in n8n

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Enables a multi-main setup for high availability in n8n's queue mode. Requires all main processes to run the same n8n version and connect to the same database and Redis instance.

```bash
export N8N_MULTI_MAIN_SETUP_ENABLED=true
```

--------------------------------

### DeepL Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up DeepL credentials in n8n. Requires a DeepL developer account and an API key. Supports Free and Pro API plans with different endpoints.

```Markdown
## DeepL Credentials

You can use these credentials to authenticate the following node:
- **DeepL**: [DeepL Node](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.deepl/)

## Prerequisites
- Create a [DeepL developer](https://www.deepl.com/pro-api) account. n8n supports both Free and Pro API Plans.

## Supported Authentication Methods
- **API Key**

## Using API Key
To configure this credential, you'll need:
- An **API Key**: Refer to [DeepL's Authentication documentation](https://developers.deepl.com/docs/getting-started/auth#authentication) for details on obtaining your API key.
- Identify which **API Plan** you are on. DeepL has different API endpoints for each plan:
  - Pro Plan
  - Free Plan
```

--------------------------------

### Keap Trigger Node Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides on setting up the Keap Trigger node for email marketing and sales automation. Includes credential information and links to examples.

```English
Keap is an e-mail marketing and sales platform for small businesses, including products to manage and optimize the customer lifecycle, customer relationship management, marketing automation, lead capture, and e-commerce.
Authentication information for this node can be found [here](https://docs.n8n.io/integrations/builtin/credentials/keap/).
For usage examples and templates to help you get started, refer to n8n's [Keap Trigger integrations](https://n8n.io/integrations/keap-trigger/) page.
```

--------------------------------

### Demio Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up Demio credentials in n8n. Requires Demio account ownership and API keys/secrets generated from Account Settings > API.

```Markdown
# Demio Credentials

## Supported Nodes
- **Demio**

## Prerequisites
- Create a Demio account.

## Supported Authentication Methods
- **API Key**

## Configuration Instructions
To configure the Demio credential, you will need:
- An **API Key**
- An **API Secret**

**Requirement:** You must have Owner status in Demio to generate API keys and secrets. 

**Steps to Generate API Keys and Secrets:**
1. Go to **Account Settings > API**.
2. Refer to the **Demio Account Owner Settings documentation** for detailed steps. 

## Dependencies
- Ensure to refer to **Demio's API documentation** for more information about the service.
```

--------------------------------

### Local n8n Node Testing Commands

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

This section provides bash commands for testing a custom n8n node locally. It includes steps for installing n8n globally, building the node, linking it locally, installing it into a local n8n instance, and starting the n8n service.

```bash
# In your node directory
npm run build
npm link

# In the nodes directory within your n8n installation
npm link <node-package-name>

n8n start
```

--------------------------------

### Discord Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide for configuring Discord credentials in n8n. Supports Bot, OAuth2, and Webhook authentication methods. Bot credentials require a Bot Token.

```Markdown
# Discord Credentials

You can use these credentials to authenticate the following node:

- Discord

## Prerequisites

- Create a Discord account.
- For Bot and OAuth2 credentials:
  - Set up your local developer environment.
  - Create an application and a bot user.
- For webhook credentials, create a webhook.

## Supported Authentication Methods

- Bot
- OAuth2
- Webhook

## Using Bot

To configure Bot credentials, you'll need:

- **Bot Token**: Generated once you create an application with a bot.
```

--------------------------------

### Qdrant Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Sets up Qdrant credentials using an API Key and Qdrant URL. Requires a Qdrant cluster and specific API key generation steps within the Cloud Dashboard.

```APIDOC
Qdrant Credentials:
  Authentication Method: API Key
  Configuration:
    - API Key: Generated from Qdrant Cloud Dashboard (Access Management or Cluster detail page)
    - Qdrant URL: URL of your Qdrant cluster
  Setup Instructions:
    1. Access Qdrant Cloud Dashboard.
    2. Navigate to Access Management or API Keys section.
    3. Create a new API Key, selecting the relevant cluster.
    4. Copy the generated API Key and Qdrant URL into the n8n credential.
```

--------------------------------

### Meta App Live Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Steps to take a Meta app live, including setting privacy policy URLs, toggling app mode, and requesting advanced access for public_profile. Requires business verification.

```APIDOC
Meta App Live Setup:
  1. Go to App Settings > Basic.
  2. Enter Privacy Policy URL.
  3. Save Changes.
  4. Toggle App Mode to Live.
  5. Request Advanced Access for public_profile (App Review > Permissions and Features).
  6. Search and select public_profile, then Request Advanced Access.
  7. Complete business verification.
  8. Use Lead Ads Testing Tool for testing.
```

--------------------------------

### One Simple API Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Provides instructions for configuring One Simple API credentials using an API token. It details where to create the token and the importance of selecting appropriate permissions.

```APIDOC
One Simple API Credentials:

Supported Authentication Methods:
  - API token

Using API Token:
  - API token: Create a new token on the API Tokens page (Profile > API Tokens).
    - Ensure appropriate permissions are selected for the token.
```

--------------------------------

### Discord Webhook Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up Discord webhooks, including creating a webhook, naming it, selecting a channel, and copying the Webhook URL to use in n8n credentials.

```APIDOC
Discord Webhook Setup:

1. Go to Discord Server Settings > Integrations.
2. Select 'Create Webhook'.
3. Assign a Name and avatar to the webhook.
4. Choose the channel for the webhook to post to.
5. Select 'Copy Webhook URL' and enter it into your n8n credential.
```

--------------------------------

### DFIR-IRIS Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide for configuring DFIR-IRIS credentials in n8n for custom API calls via the HTTP Request node. Requires an API key and the Base URL of the DFIR-IRIS instance.

```Markdown
# DFIR-IRIS Credentials

## Usage
These credentials are for authenticating with the **HTTP Request node** in n8n when making a **Custom API call**.

## Prerequisites
- An accessible instance of **DFIR-IRIS**.

## Configuration
To configure this credential, you'll need:
- An **API Key**: Refer to **DFIR-IRIS's API documentation** for instructions on obtaining your API key.
- The **Base URL** of your DFIR-IRIS instance.
```

--------------------------------

### Emelia Node Operations

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Automates work in Emelia, supporting operations on campaigns and contact lists. Includes adding contacts, creating, getting, pausing, and starting campaigns, as well as managing contact lists.

```APIDOC
Emelia Node Operations:
  Campaign:
    - Add Contact
    - Create
    - Get
    - Get All
    - Pause
    - Start
  Contact List:
    - Add
    - Get All
```

--------------------------------

### GitHub API Access Token Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Instructions for setting up GitHub credentials using an API Access Token. Requires the GitHub server URL (if not default), username, and the generated access token.

```APIDOC
GitHub API Access Token Setup:
  GitHub server: URL of the GitHub server (default if not Enterprise Server).
  User: GitHub username.
  Access Token: Generated personal access token.
```

--------------------------------

### Flow API Key Authentication

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Configuration details for Flow credentials using an API Key. Requires a numeric Organization ID and an Access Token, obtainable from Flow's API Getting Started documentation.

```APIDOC
Flow API Key Configuration:
  Supported Nodes: Flow, Flow Trigger.
  Prerequisites: Flow account.
  Authentication Method: API Key.
  Configuration:
    - Organization ID: Numeric.
    - Access Token: Generated via Flow API Getting Started documentation.
  Reference: Flow API Getting Started documentation.
```

--------------------------------

### Bitly Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Details how to set up Bitly credentials for n8n, supporting API token and OAuth2 authentication. It outlines the prerequisites and specific information needed for each method, including links to relevant Bitly API documentation.

```Markdown
# Bitly Credentials for n8n

You can use these credentials to authenticate the following node:

- **Node**: Bitly

## Prerequisites

- Create a Bitly account.

## Supported Authentication Methods

- API token
- OAuth2

## Using API Token

To configure this credential, you need:

- An **Access Token**: Once logged in, visit **Settings > Developer Settings > API** to generate an Access Token.

## Using OAuth2

- Cloud users don't need to provide connection details. Select **Connect my account** to connect through your browser.
- For more details on OAuth2 configuration, refer to the [Bitly API Authentication documentation](https://dev.bitly.com/docs/getting-started/authentication/).
```

--------------------------------

### Wufoo Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Explains how to configure Wufoo credentials in n8n using an API key. It guides users to find their API key within the Wufoo Form Manager and identify their subdomain from the Wufoo URL.

```Markdown
## Supported Authentication Methods

- API Key

## Using API Key

To configure this credential, you'll need:

- **API Key**: Get your API key from the Wufoo Form Manager. To the right of a form, select **More > API Information**.
- **Subdomain**: Your subdomain is the part of your Wufoo URL that comes after `https://` and before `wufoo.com`. For example, if the full domain is `https://n8n.wufoo.com`, the subdomain is `n8n`. Admins can view the subdomain in the **Account Manager**.
```

--------------------------------

### Twist OAuth2 Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guide for configuring Twist credentials in n8n using OAuth2. Requires creating a Twist general integration, obtaining Client ID and Client Secret, and setting up the OAuth Redirect URL.

```APIDOC
Twist Credentials:

Supported Authentication Methods:
- OAuth2

Prerequisites:
- Twist account
- General integration created with a valid OAuth Redirect URL.

Configuration:
- Requires:
  - Client ID: Generated from Twist integration.
  - Client Secret: Generated from Twist integration.

OAuth Authentication Settings:
- Copy n8n's OAuth Redirect URL and enter it as the 'OAuth 2 redirect URL' in Twist.
- Note: Twist does not accept 'localhost' Redirect URLs. Use a URL from your domain (e.g., https://mytemplatemaker.example.com/gr_callback).
- Select 'Update OAuth settings' in Twist.
- Copy Twist's Client ID and Client Secret into the n8n credential fields.
```

--------------------------------

### QuickBooks Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Sets up QuickBooks credentials using OAuth2. Requires an Intuit developer account and configuration of Client ID, Client Secret, and Environment.

```APIDOC
QuickBooks Credentials:
  Overview: Authenticate the QuickBooks node
  Authentication Method: OAuth2
  Prerequisites:
    - Intuit developer account
  Configuration:
    - Client ID: Generated during app creation
    - Client Secret: Generated during app creation
    - Environment: Select 'Production' or 'Sandbox'
```

--------------------------------

### Ollama Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Explains how to set up Ollama credentials using the Instance URL. It covers the default URL, environment variable configuration, and troubleshooting steps for self-hosted n8n instances running in different containers.

```APIDOC
Ollama Credentials:

Supported Authentication Methods:
  - Instance URL

Using Instance URL:
  - Base URL: The base URL of your Ollama instance.
    - Default: `http://localhost:11434`.
    - If `OLLAMA_HOST` environment variable is set, use that value.
    - For local n8n server issues, try `127.0.0.1` instead of `localhost`.

Ollama and Self-Hosted n8n:
  - If n8n and Ollama are in different containers, adjust `OLLAMA_ORIGINS` or `OLLAMA_HOST` to allow communication.
```

--------------------------------

### n8n Versioning and Update Information

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Information on n8n's semantic versioning strategy (MAJOR, MINOR, PATCH) and details on how to update n8n instances for both cloud and self-hosted environments. Includes links to specific installation guides.

```APIDOC
n8n Versioning:
- MAJOR: Incompatible changes requiring user action.
- MINOR: Backward-compatible functionality.
- PATCH: Backward-compatible bug fixes.

Update n8n:
- Cloud: Refer to the [Cloud update documentation](https://docs.n8n.io/manage-cloud/update-cloud-version/).
- Self-hosted (npm): [Installation via npm](https://docs.n8n.io/hosting/installation/npm/).
- Self-hosted (Docker): [Installation via Docker](https://docs.n8n.io/hosting/installation/docker/).

Version Details:
- n8n@1.99.1 (Next): Release Date: 2025-06-19, Changes: Bug fixes.
- n8n@1.98.2 (Latest): Release Date: 2025-06-18, Changes: Bug fixes.
- n8n@1.98.1: Release Date: 2025-06-12, Changes: Bug fixes.
- n8n@1.98.0: Release Date: 2025-06-11, Changes: Performance improvements and bug fixes.
- n8n@1.97.1: Release Date: 2025-06-04, Changes: Backports.
- n8n@1.95.3: Release Date: 2025-06-03, Changes: Bug fixes.
- n8n@1.97.0: Release Date: 2025-06-02, Changes: New features, performance improvements, and bug fixes.
```

--------------------------------

### Bitwarden Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Provides instructions for configuring Bitwarden credentials in n8n using an API key. It specifies the required Client ID and Client Secret for an Organization API Key and explains the 'Environment' setting for Cloud-hosted or Self-hosted instances, linking to Bitwarden's API authentication documentation.

```Markdown
# Bitwarden Credentials

## Supported Authentication Methods
- **API key**

## Using API Key
To configure this credential, you'll need:
- **Client ID**: Provided when you generate an API key
- **Client Secret**: Provided when you generate an API key
- **Environment**:
  - Choose **Cloud-hosted** if you don't self-host Bitwarden. No further configuration required.
  - Choose **Self-hosted** if you host Bitwarden on your own server. Enter your **Self-hosted domain** in the appropriate field.

The Client ID and Client Secret must be for an **Organization API Key**, not a Personal API Key. Refer to the [Bitwarden Public API Authentication documentation](https://bitwarden.com/help/public-api/#authentication) for instructions on generating an Organization API Key.
```

--------------------------------

### Odoo Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users on configuring Odoo credentials using either an API key or a password. It outlines the necessary information like Site URL, Username, Database name, and the steps to generate or input the API key or password.

```APIDOC
Odoo Credentials:

Using API Key:
  - Site URL: Your Odoo server or site URL.
  - Username: Your Odoo username.
  - Password or API key: Generated API key from Odoo.
  - Database name: Your Odoo database name.

Steps:
  1. Enter Site URL.
  2. Enter Username.
  3. Navigate to Your Profile > Preferences > Account Security > Developer API Keys in Odoo.
  4. Select 'New API Key', provide a description, and generate.
  5. Copy the generated key into the 'Password or API key' field in n8n.
  6. Enter Database name.

Using Password:
  - Site URL: Your Odoo server or site URL.
  - Username: Your Odoo username.
  - Password or API key: Your Odoo user password.
  - Database name: Your Odoo database name.

Steps:
  1. Enter Site URL.
  2. Enter Username.
  3. Enter password in the 'Password or API key' field.
  4. Enter Database name.

Password Compatibility:
  - If password authentication fails, switch to an API key.

Required Plan Type:
  - Access to the external API requires a 'Custom' Odoo plan.
```

--------------------------------

### OpenAI Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Explains the prerequisites and supported authentication method for OpenAI credentials, which is an API key. Users need an OpenAI account to generate the key.

```APIDOC
OpenAI Credentials:

Prerequisites:
  - OpenAI account.

Supported Authentication Methods:
  - API key
```

--------------------------------

### Home Assistant Credential Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Guides users on setting up Home Assistant credentials using an API access token. It details how to generate a long-lived access token within Home Assistant and configure the Host, Port, and SSL settings in n8n.

```APIDOC
Home Assistant Credential Setup:

Supported Authentication Method:
- API access token

Steps:
1. Log in to Home Assistant and navigate to your User profile.
2. In the 'Long-Lived Access Tokens' section, generate a new token.
3. Copy the generated token and enter it as the 'Access Token' in n8n.
4. Enter the Host URL or IP address of your Home Assistant instance (e.g., 'your.awesome.home').
5. Enter the appropriate Port (default HTTP: 8123, default HTTPS: 443).
6. If SSL is enabled in Home Assistant (accessing via https://), enable the 'SSL' toggle in n8n.
```

--------------------------------

### n8n Beginner Video Course

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

A playlist of YouTube videos covering the basics of n8n, including introduction, workflows, APIs, webhooks, nodes, data handling, core concepts, useful nodes, error handling, debugging, and collaboration.

```APIDOC
Beginner Course:
- Introduction and workflows: https://youtu.be/4BVTkqbn_tY?si=g2A5eD8kAoia5k6y
- APIs and Webhooks: https://youtu.be/y_cpFMF1pzk?si=zi3wM4W7nx8Jkcw3
- Nodes: https://youtu.be/rCPXBkeBWCQ?si=-T2iUsydwS5ym6yI
- Data in n8n: https://youtu.be/2YfWuNziPE4?si=4jB-fubG1_T0HXYx
- Core workflow concepts: https://youtu.be/kkrA7tGHYNo?si=mLVbuV98ohL5YVnm
- Useful nodes: https://youtu.be/Rmi-ckbMOQE?si=H_dF77uf5KJU7RtH
- Error handling: https://youtu.be/XEUVl3bbMhI?si=nUyaME5kyxe6daGO
- Debugging: https://youtu.be/Gxe_RfCRH-o?si=F-pAviLTIeL3-X13
- Collaboration: https://youtu.be/pI0W-0Qcwmo?si=X7sALFXo2e-cY9FQ
```

--------------------------------

### Pushover Credentials Setup

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Configures Pushover credentials using an API Key. Requires a Pushover account and an API Key generated from application registration.

```APIDOC
Pushover Credentials:
  Authentication Method: API Key
  Prerequisites:
    - Pushover account
  Configuration:
    - API Key: Generated during application registration (refer to https://pushover.net/api#registration)
```

--------------------------------

### Microsoft Graph Security Node Operations

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Automate tasks in Microsoft Graph Security, including getting and updating secure scores and profiles. Supports 'Get' and 'Get All' for Secure Score, and 'Get', 'Get All', and 'Update' for Secure Score Control Profile.

```APIDOC
Microsoft Graph Security Node:
  Operations:
    Secure Score:
      - Get
      - Get All
    Secure Score Control Profile:
      - Get
      - Get All
      - Update
```

--------------------------------

### n8n Project Management: Create Project

Source: https://github.com/synaptiv-ai/awesome-n8n/blob/main/n8n-docs-llms.txt

Steps for instance owners and admins to create a new project in n8n, including filling out project settings.

```APIDOC
Create a Project:
1. Select **Add project**.
2. Fill out the project settings.
3. Select **Save**.
```
Tokens:
Raw