n8n-nodes-streambim

StreamBIM automation for n8n: one community node that talks to the StreamBIM cloud API—tenant by region, JSON:API gateway, IFC search, converter jobs, sync, topics, checklists, users, workflows, attachments, and documents—so you can orchestrate BIM collaboration where your projects already live.

n8n is a fair-code licensed workflow automation platform.

Breaking changes in v8

The StreamBIM node has been bumped to typeVersion: 8 (package 0.2.0). Several per-resource field names and the list pagination UI have changed (raw JSON Query Parameters → Filters fixedCollection, custom List Pagination + Page Size + Skip + Max Pages → n8n-standard Return All + Limit). Migration: open each existing StreamBIM node, re-pick the resource/operation, and confirm filters and pagination, then save the workflow.

Installation
Resources (API surface)
Credentials
Compatibility
Usage
Development
Resources (links)
License

Installation

n8n loads third-party nodes from your n8n user folder (often ~/.n8n on the host, or /home/node/.n8n in the official Docker image). Self-hosted instances use one or both of:

| Mechanism | What it is | Official docs | |-----------|------------|----------------| | Community nodes | Packages named n8n-nodes-* installed from npm (or the in-app installer, which uses the same layout). | Community nodes, Manual install from npm | | Custom nodes | Extra directories n8n scans on startup (default subfolder custom under the user folder, or paths in N8N_CUSTOM_EXTENSIONS). | Custom nodes location |

Requirements

• Self-hosted n8n (community and custom nodes are not supported on n8n Cloud the same way).
• Node.js 18.10+ for building from source (see package.json engines).
• A StreamBIM account in the correct region (subdomain), e.g. https://app.streambim.com → region app. Regions: global.streambim.com/regions.json.

Install via Community Nodes (recommended)

1. Open n8n → Settings → Community nodes.
2. Install, enter n8n-nodes-streambim, confirm, then reload n8n when prompted.

This uses n8n’s supported community-node flow (see Community nodes).

Manual install — Community Nodes (~/.n8n/nodes)

Use this when you install from npm yourself (e.g. queue mode or a private registry), following n8n’s guide:

1. Open a shell as the same user / container that runs n8n.

2. Create the nodes directory if needed and enter it (paths match the manual install docs):

   mkdir -p ~/.n8n/nodes
   cd ~/.n8n/nodes

3. Install the package:

   npm install n8n-nodes-streambim

4. Restart n8n.

Manual install — Custom nodes directory

Use this when you ship a built copy of the package (your own dist/ + package.json) or mount a folder from Git without publishing to npm:

1. Build the package (pnpm install && pnpm run build).
2. Place the entire package folder (with package.json and dist/) under a directory n8n treats as custom extensions—by default ~/.n8n/custom/, or a path listed in N8N_CUSTOM_EXTENSIONS (semicolon-separated list). See Specify location for your custom nodes.
3. Restart n8n.

Resources (API surface)

This package ships one node:

| In n8n | Role | |---------------|------| | StreamBIM | Single node with a Resource dropdown (StreamBIM product areas) and per-resource operations. |

Resource options (high level):

• Project — List/get projects (/mgw/api/v3/... JSON:API style).
• IFC Search — Create searches and export IFC-backed query results.
• Converter Job — IFC converter jobs and status (model pipeline in StreamBIM).
• Sync — Sync trigger, activity, configs, statuses (per-project URLs where applicable).
• Topic — Topics (issues) CRUD.
• Checklist — Checklist export and listing.
• User — Users, invites, groups, email settings, project members (global and project-scoped lists).
• Workflow — Project workflows CRUD.
• Attachment — List, download, upload to topic (incl. presigned upload flow).
• Document — Documents (PDFs, drawings, IFC files), revisions, labels, folders, download links, export JSON.

Important distinction: Document and Attachment are separate resources in StreamBIM:

• Documents are the main file management system — PDFs, drawings, IFC files organized in folders with revisions, labels, and permissions at the folder level.
• Attachments are BCF-style files attached to topics (issues), viewpoints, or comments — screenshots, annotations, supporting files for collaboration.

Operations and fields follow StreamBIM’s HTTP APIs; the node adds pagination helpers for list endpoints where relevant.

Credentials

Credential type: StreamBIM API.

| Field | Purpose | |--------|---------| | Region | Tenant subdomain, e.g. app, sweden. Builds https://{region}.streambim.com. | | Authentication | Bearer token (recommended, including MFA accounts) or Username and password (login per run; MFA not supported on this path). |

Credential test

The checker follows the same pattern as core n8n credentials (e.g. Baserow / Form.io): hidden expirable sessionToken, preAuthentication for username/password login, authenticate for Authorization + JSON:API headers, and a small test GET to /mgw/api/v3/projects so a bad region or token fails fast.

Compatibility

• n8n-workflow: peer * (build targets a current 1.x workflow typings line; use an n8n release that matches your other community nodes).
• StreamBIM: API paths and JSON:API headers are aligned with StreamBIM’s gateway as used by this package; if StreamBIM changes major API versions, bump the node typeVersion and operations in-repo accordingly.

Usage

1. Install the package and restart n8n.
2. Add a StreamBIM node from the node panel (search StreamBIM).
3. Create StreamBIM API credentials: set Region, then either paste a Bearer idToken from a completed login or use Username and password for non-MFA accounts.
4. Pick Resource and Operation; choose Project where a Project Name or ID is required (dropdown loads from the API using your credential).

Region must match the organization you log into in the browser. Wrong region produces auth or empty-data errors that look like “bad credentials” but are tenant mismatches.

Development

Notes for maintainers editing this repo—not required for a normal install (see Installation above).

• Build: pnpm install then pnpm run build (TypeScript + icons).
• deploy-local.sh: convenience script for a local Docker n8n: wipes dist/, rebuilds, copies the package into a custom extensions directory on disk, and runs docker compose restart n8n. Adjust TARGET_DIR and DOCKER_COMPOSE_DIR in the script to match your machine; it is not part of the published npm package contract.

Resources (links)

• StreamBIM
• n8n community nodes
• n8n user folder
• Custom nodes location / N8N_CUSTOM_EXTENSIONS

Acknowledgement

Thanks to the StreamBIM team for the product APIs and to the n8n team for the community-node model (including credential preAuthentication / authenticate patterns this package follows).

License

MIT — see package.json.