flexlists

n8n nodes for Flexlists: read and write rows of your lists, and trigger workflows when rows change.

Package Information

Released: this month
Downloads: 0 weekly / 0 monthly
Latest Version: 0.1.0
Author: Flexlists

Available Nodes

Documentation generating…

Flexlists icon
Flexlists
Create, read, update, delete and search the rows of your Flexlists lists
Flexlists Trigger icon
Flexlists Trigger
Starts the workflow when rows of a Flexlists list are created, changed or deleted

Documentation

n8n-nodes-flexlists

n8n community nodes for Flexlists: read and write the rows of your lists,
and start workflows when rows change.

  • Flexlists: rows (create, get, get many, update, delete, search) and lists (get many, get
    fields). It can also be used as a tool by the n8n AI Agent.
  • Flexlists Trigger: starts a workflow when rows of a list are created, updated, deleted,
    archived, unarchived or imported.

Both use the Flexlists REST API v1 (/api/v1, see docs/API_V1.md and docs/WEBHOOKS.md in the
Flexlists repo, or /docs/api on any Flexlists host).

Installation · Credentials · Operations ·
Trigger · Development · End-to-end test

Installation

In n8n: Settings → Community Nodes → Install, package name n8n-nodes-flexlists.
See the n8n community nodes docs.

The package has no runtime dependencies (only n8n-workflow as a peer dependency) and uses no
restricted globals, so it can be verified for n8n Cloud.

Credentials

Credential type Flexlists API:

field
Base URL the address you use Flexlists on: https://flexlists.com (default), your workspace host, or https://test.flexlists.com
API Key a key from Flexlists → Integrations → API keys. Give it the lists the workflow needs and read + write (read is enough for the trigger and for reading)

Requests send Authorization: Bearer <key>. The credential test calls GET {baseUrl}/api/v1/me.
Flexlists → Integrations → Connect apps shows the base URL of the host you are on.

Operations

Pick the list from the dropdown (GET /api/v1/lists) or enter its ID (the id from GET /api/v1/lists).

resource operation API
Row Create POST /lists/{id}/rows
Row Get GET /lists/{id}/rows/{rowId}
Row Get Many GET /lists/{id}/rows — Return All or a limit; the cursor paging is done by the node. Options: Updated Since, Created Since, Sort By, Order
Row Update PATCH /lists/{id}/rows/{rowId} — partial: fields you do not map keep their value
Row Delete DELETE /lists/{id}/rows/{rowId}
Row Search POST /lists/{id}/rows/search — conditions field + operator (eq neq contains gt gte lt lte empty notEmpty) + value, all must match
List Get Many GET /lists (filter: workspace)
List Get Fields GET /lists/{id}/fields
  • Fields (Create, Update) is a resource mapper filled from the list's fields
    (GET /lists/{id}/fields): every field by name with its type, Choice options as a dropdown.
    Read-only fields (Formula, File, Image) are not offered. "Map Automatically" takes the input
    item's keys that are fields of the list and ignores the rest. Empty values are skipped (an
    update keeps what the row has); on Update, Clear Empty Fields sends them as null to clear.
  • Two conditions on the same field (a range: gte + lte) are allowed (the node uses the
    field's ID keys for the second and third).
  • One item in → one item out for Create, Get, Update and Delete; Get Many and Search give one
    item per row. Every output item is linked to its input item.
  • API errors are shown with the API's own message (e.g. Unknown field: "Nmae". Valid field names: "Name", "Status"). With Continue On Fail a failing item becomes { "error": "…" }.

Trigger

Choose a list and the events (row.created, row.updated, row.deleted, row.archived,
row.unarchived, rows.imported).

  • Publishing (activating) the workflow registers a webhook in Flexlists
    (POST /api/v1/webhooks); its id and signing secret are kept in the workflow's static data.
    Unpublishing removes it (DELETE /api/v1/webhooks/{id}). If the webhook was removed in
    Flexlists, or the list or events changed, it is registered again.
  • Every call is checked before anything is emitted: X-Flexlists-Signature must be
    sha256=HMAC-SHA256(secret, X-Flexlists-Timestamp + "." + raw body) and the timestamp at most
    5 minutes off. Otherwise n8n answers 401 and the workflow does not run.
  • Output: one item per row, { event, eventId, occurredAt, list: { id, name }, workspaceId, actor: { id }, changedFields?, count?, row } (row as in GET …/rows; row.deleted has only
    { id }). Option Emit One Item per Event gives one item with rows instead (bulk deletes,
    imports).
  • Flexlists' "Send test" (a ping) is answered with 200 and does not run the workflow.
  • Flexlists only calls public https:// URLs, so n8n needs a public URL (WEBHOOK_URL).

Development

Own package, not part of the Flexlists npm workspaces (the root package.json lists its
workspaces explicitly), so the app's install and build never touch it.

cd packages/n8n-nodes-flexlists
npm install
npm run build   # n8n-node build → dist/
npm run lint    # n8n-node lint (the n8n community node rules, incl. the n8n Cloud ones)
npm test        # vitest: request building, resource mapper → body, paging, signatures, both nodes
npm run dev     # n8n-node dev: a local n8n with the nodes loaded, rebuilds on change

Layout (the n8n-nodes-starter layout):

path
credentials/FlexlistsApi.credentials.ts the credential + its test
nodes/Flexlists/ the node (descriptions.ts = parameters)
nodes/FlexlistsTrigger/ the trigger (items.ts = payload → items)
nodes/shared/ transport.ts (requests, errors, paging), mapping.ts (fields ↔ resource mapper, where), signature.ts, methods.ts (list search, field options, resource mapper)
test/ unit tests (vitest)
e2e/ the real-n8n test below

End-to-end test against TEST

e2e/run.mjs drives a real n8n (e2e/docker-compose.yml, n8nio/n8n pinned) with this package
loaded, against a Flexlists env:

  1. creates the Flexlists credential through n8n's API and checks the credential test passes (and
    fails with a wrong key);
  2. imports and runs a workflow Webhook → Create → Get → Update → Search → Delete on a scratch list
    and checks every step's output;
  3. imports and publishes a Flexlists Trigger workflow, checks the webhook appears in Flexlists,
    creates, updates and deletes a row through API v1 and checks each event is an execution with the
    right data, checks a forged call gets 401 and a ping starts nothing, then unpublishes and checks
    the webhook is gone from Flexlists.

Everything it creates is removed again, also when a check fails.

You need Docker, an API key on TEST (Integrations → API keys: whole account, read + write) and a
public https URL for n8n, e.g. a Cloudflare quick tunnel (Flexlists refuses *.ts.net, private
addresses and its own hosts as webhook targets):

cd packages/n8n-nodes-flexlists
npm install && npm run build

# 1. a tunnel to the n8n port; note the https://….trycloudflare.com URL it prints
cloudflared tunnel --url http://localhost:5678

# 2. n8n with the package (WEBHOOK_URL = the tunnel)
N8N_WEBHOOK_URL=https://<name>.trycloudflare.com/ docker compose -f e2e/docker-compose.yml up -d

# 3. the test
FLR_BASE=https://test.flexlists.com FLR_KEY=<key> N8N_WEBHOOK_URL=https://<name>.trycloudflare.com/ npm run e2e

# 4. done
docker compose -f e2e/docker-compose.yml down

N8N_URL (default http://localhost:5678) points the script at another n8n. The n8n owner is
created on a fresh n8n (N8N_EMAIL / N8N_PASSWORD, defaults in the script). Loaded from n8n's
custom folder the node types are CUSTOM.flexlists / CUSTOM.flexlistsTrigger; installed from
npm they are n8n-nodes-flexlists.flexlists / n8n-nodes-flexlists.flexlistsTrigger. The script
finds them itself.

Publishing (later, needs approval)

Not now. When approved: remove "private": true, set the version, npm run lint && npm run build && npm test, then npm publish --provenance (prepublishOnly runs n8n-node prerelease). After that
it can be submitted for n8n Cloud verification.

Licence

MIT

Discussion