Description

n8n-nodes-ziflow

Community node package for integrating n8n with the ZiFlow proof-management API.

This repository ships the legacy compatibility ZiFlow node, split ZiFlow domain nodes, one credential type, compiled runtime files under dist/, and documentation for the live workflow compatibility contract. The split nodes map all 104 operations in the current official ZiFlow OpenAPI contract.

Install | Credentials | Node Layout | Repository Structure | Build Semantics | Compatibility Contract | API Mapping | Validation

Install

n8n Community Nodes

In n8n:

1. Go to Settings > Community Nodes.
2. Select Install a community node.
3. Enter n8n-nodes-ziflow.
4. Install and restart n8n.

Manual Install

npm install n8n-nodes-ziflow

For repository development:

npm install
npm run build

Credentials

Credential type: ziFlowApi

Defined in credentials/ZiFlowApi.credentials.ts.

| Field | Purpose |
| — | — |
| API Key | ZiFlow API key sent in the apikey header |
| Base URL | ZiFlow API base URL, usually https://api.ziflow.io |

Node Layout

Existing workflows continue to use the original ZiFlow node (n8n-nodes-ziflow.ziFlow). New workflows should use the split domain nodes:

| Node | Scope |
| — | — |
| ZiFlow | Legacy compatibility node for saved workflows |
| ZiFlow Proofs | Proofs, stages, reviewers, proof checklists, proof exports |
| ZiFlow Folders | Folders, folder sharing, folder URLs |
| ZiFlow Comments | Comments, reactions, labels, resolution |
| ZiFlow People | Users, contacts, guests, SCIM users |
| ZiFlow Templates | Workflow templates and checklist templates |
| ZiFlow Webhooks | Webhook subscriptions |
| ZiFlow Admin | Custom properties, decision settings, integrations, intake forms |
| ZiFlow API Request | Authenticated escape hatch for any ZiFlow path |

Each split domain node offers two input styles:

• Native Fields is the default. The selected operation shows its documented path fields, query filters, and nested request-body fields directly in n8n.
• Advanced JSON exposes the full path, query, or body object when a workflow needs a dynamic payload or a newly introduced API value.

Saved split-node workflows that already contain pathParametersJson, queryParametersJson, or bodyJson continue to execute in compatibility mode without requiring a workflow edit.

Repository Structure

Important tracked files and runtime outputs:

• README.md
• README_TEMPLATE.md
• CHANGELOG.md
• CODEOFCONDUCT.md
• LICENSE.md
• package.json
• tsconfig.json
• eslint.config.mjs
• credentials/ZiFlowApi.credentials.ts
• credentials/ziflow.svg
• credentials/ziflow.dark.svg
• icons/ziflow.svg
• nodes/ZiFlow/ZiFlow.node.ts
• nodes/ZiFlow/ZiFlowProofs.node.ts
• nodes/ZiFlow/ZiFlowFolders.node.ts
• nodes/ZiFlow/ZiFlowComments.node.ts
• nodes/ZiFlow/ZiFlowPeople.node.ts
• nodes/ZiFlow/ZiFlowTemplates.node.ts
• nodes/ZiFlow/ZiFlowWebhooks.node.ts
• nodes/ZiFlow/ZiFlowAdmin.node.ts
• nodes/ZiFlow/ZiFlowApiRequest.node.ts
• nodes/ZiFlow/shared/ZiFlowOpenApiContract.ts
• nodes/ZiFlow/shared/ZiFlowDomainNode.ts
• nodes/ZiFlow/ziflow.svg
• dist/credentials/ZiFlowApi.credentials.js
• dist/credentials/ZiFlowApi.credentials.d.ts
• dist/credentials/ziflow.svg
• dist/nodes/ZiFlow/ZiFlow.node.js
• dist/nodes/ZiFlow/ZiFlow.node.d.ts
• dist/nodes/ZiFlow/ziflow.svg
• docs/APICONTRACTMAPPING.md
• docs/BUILDANDRELEASE.md
• docs/WORKFLOW_COMPATIBILITY.md
• nodes/ZiFlow/README.md

Build Semantics

Build command:

npm run build

Current build script uses the official n8n node tool:

npm run n8n-node:build

Development watch script:

node ./node_modules/typescript/bin/tsc --watch

The split-node package also includes public:export and public:scan scripts for producing a sanitized public customer package from the private maintenance repo.

Package manifest semantics:

| Field | Current value |
| — | — |
| Package | n8n-nodes-ziflow |
| Runtime node entries | dist/nodes/ZiFlow/*.node.js |
| Runtime credential entry | dist/credentials/ZiFlowApi.credentials.js |
| Source node | nodes/ZiFlow/ZiFlow.node.ts |
| Source credential | credentials/ZiFlowApi.credentials.ts |
| Icon | bundled file:ziflow.svg / file:ziflow.dark.svg |

More detail: Workflow Compatibility.

API Mapping

The current official ZiFlow OpenAPI contract is mapped in ANDRELEASE.md”>Build and Release

• Workflow Compatibility
• Node-local notes
• GitHub repository
• n8n community nodes documentation

License

See the repository license file.