Description

n8n-nodes-ziflow-lab

This node is experimental

n8n community nodes for the Ziflow creative review and proofing platform. Automate proof creation, reviewer management, and workflow orchestration directly inside n8n.

Nodes

Ziflow

An action node for interacting with the Ziflow REST API. Supports eight resources:

| Resource | Operations |
|—|—|
| Proof | Create, Get, List, Update, Delete |
| Comment | Create, Get, List |
| Folder | Create, Get, List, Update, Delete |
| Reviewer | Add, Get, Update, Delete |
| Stage | Update |
| User | Create, Get, List, Update, Delete |
| Webhook | Create, List, Delete |
| Workflow Template | Create, Get, List, Update, Delete |

Ziflow Trigger

A webhook trigger node that starts an n8n workflow when Ziflow proof events occur. On activation it automatically registers a webhook with Ziflow and validates incoming requests using HMAC-SHA256 signature verification. On deactivation it removes the webhook from Ziflow.

Supported events:

• All Events
• Comment / Comment Reaction
• Complete Review
• Created / Deleted / Restored
• Decision
• First Opened
• Mentions
• Processed
• Shared
• Stage Deadline Passed / Stage Locked / Stage Started
• Status Change
• Summary

Authentication

Both nodes use the Ziflow API credential type, which authenticates with a single API key sent as the apikey header. You can find or generate your API key in your Ziflow account settings.

Local Development Setup

Prerequisites

• Node.js v22+ — install via nvm (recommended) or from nodejs.org
• npm (bundled with Node.js)
• git

Steps

1. Clone the repo

   git clone https://github.com/ziflow-design/ziflow-n8n-lab.git
   cd n8n-nodes-ziflow
   

2. Install dependencies

   npm install
   

This installs all dev dependencies including @n8n/node-cli, which bundles n8n for local development — no separate n8n installation needed.

3. Start the dev server

   npm run dev
   

This builds the TypeScript, starts a local n8n instance with the Ziflow nodes loaded, and watches for file changes. n8n opens at http://localhost:5678.

4. Add your credentials in n8n

In the local n8n UI, create a Ziflow API credential and paste your Ziflow API key. The credential is verified automatically against GET /v1/users.

5. Build your workflows

Add the Ziflow or Ziflow Trigger node to a workflow and start testing.

Available Scripts

| Script | Description |
|—|—|
| npm run dev | Start n8n with nodes loaded and watch for changes |
| npm run build | Compile TypeScript to dist/ for production |
| npm run build:watch | Compile in watch mode (no n8n instance) |
| npm run lint | Check for errors and style issues |
| npm run lint:fix | Auto-fix linting issues |
| npm run release | Bump version, update changelog, tag, and push |

Troubleshooting

Node doesn’t appear in n8n

• Confirm it’s listed in package.json under n8n.nodes
• Restart the dev server with npm run dev
• Check the terminal for TypeScript or build errors

TypeScript errors

• Ensure you’re on Node.js v22 or higher
• Run npm install to make sure all type definitions are present

Resources

• Ziflow API Documentation
• n8n Node Development Guide
• @n8n/node-cli Documentation

License

MIT