@dms-one/n8n-nodes-flex
v0.1.4
Published
A n8n node package to interact with Flex API
Keywords
Readme
@dms-one/n8n-nodes-flex
n8n community node package for DMS One Flex — document and workflow APIs you can call from workflows.
Flex is the web-facing layer of the DMS One stack. This package exposes a single Flex node with multiple resources (tasks, users, workflow tasks).
Contents: Installation · Credentials and tokens · Impersonation header · Resources and operations · Example workflow · Links
Installation
Install as a community node (self-hosted n8n). The package name is:
@dms-one/n8n-nodes-flex
After installation, add Flex API credentials (see below) and use the Flex node in your workflows.
For packaging standards and submitting to the community index, see Submit community nodes and the verification guidelines.
Credentials and tokens
Create Flex API credentials in n8n and set:
| Field | Purpose |
| --- | --- |
| Base URL | Flex API root (default https://flex.dmsone.hu/api). Use your tenant URL if your organization hosts Flex elsewhere. |
| Authentication Method | Personal Access Token or Station Token. |
| Token | The secret string for the chosen method. |
| Impersonated User Email | Shown only for Station Token — optional email of the user to act as (see Impersonation). |
| Ignore SSL Issues | Only for dev/self-signed certs; not recommended in production. |
Personal Access Token (PAT)
- Sign in to your organization’s Flex web application (e.g. flex.dmsone.hu if that is your tenant).
- Open the user / account menu (typically from your name or avatar in the UI).
- Use the menu entry for personal access tokens (wording may match your Flex locale) and create a new token.
- Copy the token into n8n Token and set Authentication Method to Personal Access Token.
PATs run API calls as you. They can expire; renew or replace the token in credentials when Flex reports it invalid.
Station token
A station (machine / integration) token is a service credential, usually created or distributed by a Flex administrator in your organization — not from the same personal menu as a PAT. Paste it into Token and set Authentication Method to Station Token.
Use a station token when automation should run under a dedicated integration account and optionally impersonate different users via email (below).
Impersonation (station token only)
When Authentication Method is Station Token, you can set Impersonated User Email to a Flex user’s email address.
For each HTTP request, the credential adds:
X-Impersonated-User-Email: <that email>
so the Flex API treats the call as that user (subject to server-side permissions). If the field is empty, that header is not sent and the call uses the station token’s own identity.
Personal Access Token mode does not use this header; the PAT already identifies a single user.
Resources and operations
In the Flex node, pick a Resource, then an Operation.
Task (task)
| Operation | What it does |
| --- | --- |
| Create | Start a new DMS task (POST /dms/task/start). |
| Comment | Add a comment on a task. |
| Accept | Accept a task. |
| Complete | Mark a task complete. |
| List | List tasks by status (in-progress, completed, pending, all). |
User (user)
| Operation | What it does | | --- | --- | | Get by Username | Resolve a user by Flex username. |
Workflow (workflow)
Workflow operations target workflow engine tasks (templates, assignments, attachments), distinct from the simple Task resource above.
| Operation | What it does | | --- | --- | | Get Available Templates | List workflow templates. | | Get Template Details | Metadata / required fields for a template. | | Start Workflow | Start a process from a template (including metadata and optional files). | | Get My Tasks | Tasks assigned to the current (or impersonated) user. | | Get Task Details | Full detail for one workflow task. | | Complete Task | Complete a workflow task with result and optional comment. | | Get Task Comments / Add Task Comment | Read or add comments on a workflow task. | | Get Task Attachments / Get Task Related Attachments | List attachments for a task. | | Download Attachment | Download a file by attachment GUID. |
Example workflow
Goal: Start a workflow from a template, using fields returned by Flex.
- Credentials — Create Flex API with a PAT or station token (+ impersonation email if needed). Test with Credential → Test (calls
GET …/diag). - Trigger — e.g. Manual Trigger or your real trigger (webhook, schedule).
- Flex (1) — Resource Workflow, operation Get Available Templates. Note a
id(and name) of the template you need. - Flex (2) — Resource Workflow, operation Get Template Details, Template ID from step 3. Inspect the output so you know required metadata keys and types.
- Flex (3) — Resource Workflow, operation Start Workflow. Choose the same template, fill metadata (and optional binary files) according to step 2’s structure. Execute the workflow.
A smaller alternative: Workflow → Get My Tasks → Get Task Details on one task id → Add Task Comment to append a note from n8n.
Links
- Flex (default product URL; yours may differ.)
- n8n community nodes
- Submit community nodes
- Source: github.com/dmsreg/n8n-nodes-dmsone-flex
License
MIT (see license in package.json).
