Skip to main content
This guide walks you through installing the Chariow community node on a self-hosted n8n instance and connecting it to your store.

​
Prerequisites

Before you begin, make sure you have:
  • A self-hosted n8n instance (v1.0 or later)
  • A Chariow API key (starts with sk_) — generate one from Settings → API Keys in your Chariow Dashboard
  • Node.js >= 18.10 on the machine running n8n

​
Installation

The Chariow node is not yet available through the n8n Community Nodes UI. You must install it manually using one of the methods below.
Run the following command in your n8n user directory: 
cd ~/.n8n && npm install @chariow/n8n-nodes-chariow
Then restart n8n for the node to appear.

​
Docker

If you run n8n in Docker, set the N8N_CUSTOM_EXTENSIONS environment variable to install the package on startup: 
# docker-compose.yml
services:
  n8n:
    image: n8nio/n8n
    environment:
      - N8N_CUSTOM_EXTENSIONS=@chariow/n8n-nodes-chariow
    # ... your other config
Restart the container after updating the configuration.
Community Nodes UI support is planned. Once available, you will be able to install directly from Settings → Community Nodes inside n8n.

​
Configure credentials

1

Open credentials

In n8n, go to Settings → Credentials → Add Credential.
2

Search for Chariow

Search for Chariow API and select it.
3

Enter your API key

Paste your Chariow API key (starts with sk_) into the API Key field.
4

Save

Click Save. n8n will test the connection automatically. A green tick confirms your key is valid.

​
Verify installation

1

Create a new workflow

Click New Workflow in n8n.
2

Add a node

Click + to add a node and search for Chariow.
3

Confirm both nodes appear

You should see two nodes:
  • Chariow — for performing actions (get, list, create)
  • Chariow Trigger — for starting workflows from store events

​
Troubleshooting

  • Make sure you installed the package in the correct directory (~/.n8n for npm installs)
  • Restart n8n completely after installation
  • Check the n8n logs for any installation errors: docker logs n8n or check your process output
  • Verify the package is installed: ls ~/.n8n/node_modules/@chariow
  • Confirm your API key starts with sk_ and is copied in full
  • Check that your store is active in the Chariow dashboard
  • Ensure your n8n instance can reach https://api.chariow.com (no firewall or proxy blocking)
  • Verify the N8N_CUSTOM_EXTENSIONS environment variable is set correctly
  • Rebuild and restart the container: docker compose down && docker compose up -d
  • Check container logs for npm install errors: docker logs <container_name>

​
Next steps

Available resources

See all resources and operations

Trigger events

Browse the 8 available trigger events