n8n-nodes-ziflow
v1.1.1
Published
Complete ZiFlow API community nodes with native fields and advanced JSON input
Downloads
333
Maintainers
Readme
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:
- Go to Settings > Community Nodes.
- Select Install a community node.
- Enter
n8n-nodes-ziflow. - Install and restart n8n.
Manual Install
npm install n8n-nodes-ziflowFor repository development:
npm install
npm run buildCredentials
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.mdREADME_TEMPLATE.mdCHANGELOG.mdCODE_OF_CONDUCT.mdLICENSE.mdpackage.jsontsconfig.jsoneslint.config.mjscredentials/ZiFlowApi.credentials.tscredentials/ziflow.svgcredentials/ziflow.dark.svgicons/ziflow.svgnodes/ZiFlow/ZiFlow.node.tsnodes/ZiFlow/ZiFlowProofs.node.tsnodes/ZiFlow/ZiFlowFolders.node.tsnodes/ZiFlow/ZiFlowComments.node.tsnodes/ZiFlow/ZiFlowPeople.node.tsnodes/ZiFlow/ZiFlowTemplates.node.tsnodes/ZiFlow/ZiFlowWebhooks.node.tsnodes/ZiFlow/ZiFlowAdmin.node.tsnodes/ZiFlow/ZiFlowApiRequest.node.tsnodes/ZiFlow/shared/ZiFlowOpenApiContract.tsnodes/ZiFlow/shared/ZiFlowDomainNode.tsnodes/ZiFlow/ziflow.svgdist/credentials/ZiFlowApi.credentials.jsdist/credentials/ZiFlowApi.credentials.d.tsdist/credentials/ziflow.svgdist/nodes/ZiFlow/ZiFlow.node.jsdist/nodes/ZiFlow/ZiFlow.node.d.tsdist/nodes/ZiFlow/ziflow.svgdocs/API_CONTRACT_MAPPING.mddocs/BUILD_AND_RELEASE.mddocs/WORKFLOW_COMPATIBILITY.mdnodes/ZiFlow/README.md
Build Semantics
Build command:
npm run buildCurrent build script uses the official n8n node tool:
npm run n8n-node:buildDevelopment watch script:
node ./node_modules/typescript/bin/tsc --watchThe 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: Build and Release.
Runtime Semantics
The node executes one n8n input item at a time.
- Reads API Key and Base URL from ziFlowApi credentials.
- Normalizes Base URL by trimming a trailing slash.
- Sends REST requests through n8n credential authentication.
- Builds requestOptions per resource and operation, then calls
httpRequestWithAuthentication. - Returns response data to n8n or throws NodeOperationError on failure.
Compatibility Contract
This node is used by saved workflows in the live n8n instance. Backward compatibility includes node identity, declared versions, resource values, operation values, parameter names, icon loading, and editor hydration.
| Field | Value |
| --- | --- |
| Display name | ZiFlow |
| Internal node name | ziFlow |
| Runtime workflow type | n8n-nodes-ziflow.ziFlow |
| Declared versions | [10] |
| Credential type | ziFlowApi |
| Saved workflow usage | 11 saved ZiFlow nodes currently use typeVersion 10 in the live n8n database. |
Do not change these values without a saved-workflow migration and browser/editor validation.
More detail: Workflow Compatibility.
API Mapping
The current official ZiFlow OpenAPI contract is mapped in API Contract Mapping. That document maps 104 official operations to split domain nodes and is the first file to diff when ZiFlow changes its API.
Operations
The legacy node still exposes its existing broad resource and operation values for workflow compatibility. New development should use the split domain nodes and the mapping document above.
| Resource Display | Resource Value | Operations |
| --- | --- | --- |
| Folder | folder | list, get, getSubfolders, create, update, delete, archive, unarchive, move, search, getFolderUrl, getShare, updateShare |
| Proof | proof | list, get, create, update, delete, archive, getProofUrl, getReviewUrl, addFile, uploadFile, listFiles, lock, unlock, listVersions, copy, search, searchActivity, getActivities, deleteAllVersions, disconnectVersion, getEmails, addIntegrationProperties, updateIntegrationProperties, makeDecision, exportSummaryPdf, exportSummaryPdfWebhook, getSummaryPdfExportStatus, exportCommentsPdf, exportCommentsPdfWebhook, getCommentsPdfExportStatus |
| File | file | list, get, upload, download, update, delete |
| Review | review | list, get, submit, update, delete, getAllForProof |
| Comment | comment | list, get, add, update, reply, delete, label, like, addReactions, resolve |
| Reviewer | reviewer | list, get, add, update, remove |
| Webhook | webhook | list, get, create, update, delete, test |
| Template | template | list, get, create, update, delete |
| Version | version | list, get, compare, restore |
| User | user | list, get, create, update, delete, invite |
| Team | team | list, get, create, update, delete, addMember, removeMember |
| Workflow Stage | workflowStage | list, get, create, update, delete |
| Decision | decision | list, get, submit, update |
| Comment Label | commentLabel | list, get, create, update, delete |
| Contact | contact | list, get |
| Checklist Template | checklistTemplate | list, create, get, delete |
| Decision Checklist | decisionChecklist | get, update, addOption, getOption, updateOption, deleteOption |
| Decision Reason | decisionReason | get, update, addOption, getOption, updateOption, deleteOption |
| Guest | guest | add, update, delete |
| Intake Form | intakeForm | list |
| Integration | integration | list, getConnections, getPropertyGroups, getPropertyGroupProperties |
| Workflow Template | workflowTemplate | list, get, create, update, delete |
| SCIM User | scimUser | list, get, create, update |
| Custom Property | customProperty | listGroups, getGroup, createGroup, updateGroup, deleteGroup, getPropertyOptions, addPropertyOption, getPropertyOption, updatePropertyOption |
| Proof Stage | proofStage | updateStage, startStage, setFinalStatus, addReviewer, getReviewer, updateReviewer, deleteReviewer, addChecklists, getChecklist, markChecklistItem |
| API Request | apiRequest | make |
Service Notes
- ZiFlow already declares version 10, matching live saved workflows.
- Many resources are mutating proof, review, webhook, team, user, and decision state; validate with read operations first.
- API Request is an authenticated escape hatch under the configured ZiFlow API base URL for endpoints not promoted to first-class operations yet.
- The repo previously still had starter README content; this documentation replaces that with node-specific runtime details.
Validation
Minimum local validation:
npm test
npm run lint
npm audit --omit=dev --omit=peer
npm pack --dry-runMinimum live validation after deployment:
- Confirm n8n health is green.
- Confirm n8n is loading the intended package commit.
- Confirm the public icon route returns SVG.
- Query saved workflows for
n8n-nodes-ziflow.ziFlownodes. - Validate saved
typeVersionvalues against declared versions. - Validate saved
resourceandoperationvalues against current option lists. - Open representative workflows in the n8n editor and verify icon, subtitle, resource, operation, and required fields.
Do not skip browser/editor validation after large node builds.
Related Docs
- Build and Release
- Workflow Compatibility
- Node-local notes
- GitHub repository
- n8n community nodes documentation
License
See the repository license file.
