Skip to content
HIPE Logo Developers - HIPE

Install n8n and the HIPE node

This page explains how to:

  • Install or reuse an n8n instance.
  • Install the HIPE community node @packitoo/n8n-nodes-hipe.
  • Configure credentials and run a first test workflow.

n8n itself is documented and maintained by the n8n team. We intentionally link to their official documentation instead of duplicating it here.

1. Install n8n

Section titled “1. Install n8n”

You are responsible for hosting and operating your own n8n instance. HIPE does not host n8n for you, but we can help you install and configure it inside your infrastructure.

Recommended approach:

Alternative options and details are available in the n8n documentation:

Security expectation

  • n8n should run on infrastructure you control (VMs, Kubernetes, on‑prem, or cloud).
  • Access to n8n and to any internal systems and databases it connects to (for example, ERP or CRM databases) should go through a VPN or private network, not a public endpoint.
  • Communication from n8n to HIPE happens only over the HIPE HTTP API, protected by your network rules and HIPE access tokens.
  • We recommend following n8n’s hardening and backup guidelines.

2. Install the HIPE community node

Section titled “2. Install the HIPE community node”

The HIPE integration is packaged as a community node published on npm and available from the n8n UI.

From the n8n UI (recommended)

  1. Sign in to your n8n instance as an admin.

  2. Go to Settings → Community Nodes.

  3. Click Install a community node.

  4. Enter the package name:

    @packitoo/n8n-nodes-hipe

  5. Confirm the installation and security prompts.

  6. Restart n8n if prompted.

From npm / command line (advanced)

If you manage n8n as a Node.js project, you can also install the package directly (see the GitHub README):

Terminal window
npm install @packitoo/n8n-nodes-hipe

After installation, restart n8n so the new node is loaded.

3. Configure HIPE credentials

Section titled “3. Configure HIPE credentials”

The HIPE node uses a HIPE API token for authentication.

  1. Create a HIPE access token
    Follow the guide: Create an access token.

  2. Create HIPE credentials in n8n

    • In n8n, go to Credentials.
    • Click New and select the HIPE credentials type (provided by the HIPE node).
    • Enter:
      • Your HIPE base URL (for example, production or sandbox URL).
      • The API token you created.

  3. Test the connection
    Use the Test button in the credentials modal. The node performs a safe GET request to validate your token and base URL.

If the test fails, check:

  • Network access from n8n to the HIPE URL (VPN, DNS, firewalls).
  • Token validity and permissions.

For more details, see the Authentication section of the n8n‑nodes‑hipe README.

4. Run a first smoke test

Section titled “4. Run a first smoke test”

Once the node and credentials are configured, you can create a simple workflow to validate everything end‑to‑end.

  1. Create a new workflow in n8n.
  2. Add a Manual Trigger node.
  3. Add a HIPE node and connect it to the trigger.
  4. In the HIPE node:
    • Select your HIPE credentials.
    • Choose a module such as Users.
    • Pick a simple operation such as Get many or List.
  5. Execute the workflow.

If the response shows data from HIPE, your setup is working.

5. Available modules and operations

Section titled “5. Available modules and operations”

The HIPE node exposes multiple modules (Users, Companies, Projects, Pipelines, Imports/Exports, Corrugated, etc.) with their own operations.

  • The authoritative, up‑to‑date list of supported modules and operations is maintained in the GitHub repository:
    Module Readiness – n8n-nodes-hipe
  • In the n8n UI, the Module and Operation dropdowns also reflect the current capabilities of the installed version.

This avoids maintaining two different sources of truth in the documentation.

6. Security and network model

Section titled “6. Security and network model”

To protect your data while enabling automation:

  • n8n and any internal databases/systems it connects to should only be reachable inside your private network, typically through a VPN.
  • HIPE is accessed from n8n only via HTTPS API calls, never by opening direct database connections from HIPE to your systems.
  • When connecting n8n to your own databases (for example, MySQL), we recommend:
    • A dedicated database account, ideally read‑only for reporting/ETL use cases.
    • Network segmentation so those databases are not exposed to the public internet.
  • HIPE does not host your n8n instance; it is deployed in your infrastructure with your authentication and security policies.

We are available to review your proposed architecture with your security and infrastructure teams.