> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firstpromoter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n node

> Integrate FirstPromoter n8n node in your workflow.

# What is n8n?

[n8n](https://n8n.io/) is a workflow automation platform that lets you connect FirstPromoter to hundreds of other services.

The [FirstPromoter](https://www.npmjs.com/package/@firstpromoter/n8n-nodes-firstpromoter) n8n node lets you start a workflow when a webhook event is received or use the FirstPromoter v2 API to perform many actions or operations.

# Requirements

* n8n instance — self host(local machine or docker-based) or n8n-cloud based. [See n8n docs](https://docs.n8n.io/hosting/)
* Authentication credentials — API key and Account ID. See [Setting up credentials](#-setting-up-credentials) for details on generating/accessing API keys and Account ID.

# Installation

To install the [FirstPromoter](https://www.npmjs.com/package/@firstpromoter/n8n-nodes-firstpromoter) n8n node, make sure the n8n instance is already running. See the [official n8n docs](https://docs.n8n.io/hosting/) if you need to install it first.

## Install FirstPromoter n8n node

The [FirstPromoter](https://www.npmjs.com/package/@firstpromoter/n8n-nodes-firstpromoter) n8n node can be installed through the local self-hosted n8n instance or the n8n Cloud-based instance. [See n8n docs](https://docs.n8n.io/hosting/)

<Tip>
  Community nodes require N8N\_COMMUNITY\_PACKAGES\_ENABLED=true in your n8n environment. Most installations have this enabled by default. If you cannot access the Community Nodes section in Settings, set this variable before starting n8n.
</Tip>

### Self Hosted

For self-hosted n8n instances, you can install the FirstPromoter node directly via the web interface by following the steps below:

<Steps>
  <Step title="Step 1">
    Open n8n in your browser (typically `http://localhost:5678`)
  </Step>

  <Step title="Step 2">
    Navigate to **Settings** → **Community Nodes**
  </Step>

  <Step title="Step 3">
    Click "**Install a community node**"
  </Step>

  <Step title="Step 4">
    Enter package name: `@firstpromoter/n8n-nodes-firstpromoter`
  </Step>

  <Step title="Step 5">
    Click **Install** and wait for the installation to complete
  </Step>

  <Step title="Step 6">
    Refresh your browser and [set up credentials](#-setting-up-credentials)
  </Step>
</Steps>

### n8n Cloud

The [FirstPromoter](https://www.npmjs.com/package/@firstpromoter/n8n-nodes-firstpromoter) n8n node requires verification to be available on the n8n Cloud. n8n Cloud supports a select group of verified community nodes included in their official catalog.

<Note>
  **Current Status**: Until the [FirstPromoter](https://www.npmjs.com/package/@firstpromoter/n8n-nodes-firstpromoter) n8n node is verified and included in the Cloud-available catalog, use self-hosted n8n (local or Docker) with any of the installation methods above.
</Note>

# 🔑 Setting Up Credentials

Before using the [FirstPromoter](https://www.npmjs.com/package/@firstpromoter/n8n-nodes-firstpromoter) n8n node, configure your connection credentials:

| Field      | Required | Description              |
| ---------- | -------- | ------------------------ |
| Account ID | yes      | FirstPromoter Account ID |
| API Key    | yes      | v2 API key               |

<Tip>
  **Get your credentials on FirstPromoter**

  1. Log in to your **FirstPromoter** dashboard.
  2. Go to **Settings → Integrations → API integration** section.
     * Copy your **Account id**.
  3. Click **Manage API keys**
     * Add New API key or copy existing API key

  <Note>
    **Tip:** If you rotate keys, update the n8n credential and re-run affected workflows
  </Note>
</Tip>

To add credentials in the n8n instance via the web interface, follow the steps below:

<Steps>
  <Step title="Step 1">
    Click the plus icon **+** on the top-left
  </Step>

  <Step title="Step 2">
    Click **New Credential**
  </Step>

  <Step title="Step 3">
    Search for **FirstPromoter API**
  </Step>

  <Step title="Step 4">
    Fill in the required fields.

    * Account ID
    * API Key
  </Step>

  <Step title="Step 5">
    Click **Save**
  </Step>

  <Step title="Step 6">
    Click the close icon "**x"** or click anywhere outside of the modal to close
  </Step>

  <Step title="Step 7">
    Create a new workflow or open an existing workflow and add the **FirstPromoter** n8n node.
  </Step>
</Steps>

<img src="https://mintcdn.com/firstpromoter/vbk7mRPEKU3Kd-zO/images/n8n/step-1-click-plus-icon.png?fit=max&auto=format&n=vbk7mRPEKU3Kd-zO&q=85&s=ebacd13393ee9f2a6a82f4625791c01c" alt="Step 1" width="3594" height="1705" data-path="images/n8n/step-1-click-plus-icon.png" />

<img src="https://mintcdn.com/firstpromoter/vbk7mRPEKU3Kd-zO/images/n8n/step-2-new-credentials.png?fit=max&auto=format&n=vbk7mRPEKU3Kd-zO&q=85&s=ad4769b38421c6a9118b3111b09e20cb" alt="Step 2" width="3299" height="1608" data-path="images/n8n/step-2-new-credentials.png" />

<img src="https://mintcdn.com/firstpromoter/vbk7mRPEKU3Kd-zO/images/n8n/step-3a-search.png?fit=max&auto=format&n=vbk7mRPEKU3Kd-zO&q=85&s=d4a91601927da31ed5905823201b78c5" alt="Step 3a" width="3010" height="1775" data-path="images/n8n/step-3a-search.png" />

<img src="https://mintcdn.com/firstpromoter/vbk7mRPEKU3Kd-zO/images/n8n/step-3b-seach-and-continue.png?fit=max&auto=format&n=vbk7mRPEKU3Kd-zO&q=85&s=f5e93ff2e7d8f8d9b64d9a733eb043c0" alt="Step 3b" width="3301" height="1627" data-path="images/n8n/step-3b-seach-and-continue.png" />

<img src="https://mintcdn.com/firstpromoter/vbk7mRPEKU3Kd-zO/images/n8n/step-4-and-5-fill-and-save.png?fit=max&auto=format&n=vbk7mRPEKU3Kd-zO&q=85&s=35de57dae759dd0d3aac21d859ce392c" alt="Step 4&5" width="3172" height="2001" data-path="images/n8n/step-4-and-5-fill-and-save.png" />

<img src="https://mintcdn.com/firstpromoter/vbk7mRPEKU3Kd-zO/images/n8n/step-6-close-dialog.png?fit=max&auto=format&n=vbk7mRPEKU3Kd-zO&q=85&s=cb4ffed4a1488d6c58038aedd25b8cf3" alt="Step 6" width="3172" height="1997" data-path="images/n8n/step-6-close-dialog.png" />