Official Liveblocks n8n node repository. Use these nodes to download and modify room storage, interact with threads, comments, and attachments, send notifications and more in realtime.
Install this package as a community node in your n8n instance.
- Open n8n and go to Settings → Community nodes.
- Select Install and enter
n8n-nodes-liveblocksas the npm package name. - Check ☑︎ I understand… and click Install.
Liveblocks and Liveblocks Trigger will now appear in the node palette.
The package provides two nodes.
Calls the Liveblocks REST API. Choose a resource, then an operation. Operations map to the API (rooms, storage, Yjs, comments, inbox, webhooks-related server flows, etc.).
| Resource | What you can do (examples) |
|---|---|
| Room | List, create, update, delete, and upsert rooms; change room or organization IDs; prewarm; list active users; set presence; broadcast custom events to the room. |
| Storage | Get, initialize, patch (JSON Patch), or delete Liveblocks storage documents. |
| Yjs | Read Yjs state, send binary updates, list versions, and create or fetch specific versions. |
| Thread | CRUD threads; edit metadata; resolve/unresolve; subscribe/unsubscribe; list subscriptions and thread inbox notifications. |
| Comment | Create, read, edit, and delete comments; add/remove reactions; edit metadata. |
| Attachment | Download comment attachments (binary response when applicable). |
| User | Identify users for Liveblocks features that require user metadata. |
| Inbox | Inbox notifications, notification settings, room subscription settings, mark-as-read, and related triggers. |
| Group | Manage groups and membership; list a user’s groups. |
| AI Copilot | List, create, read, update, and delete AI copilot configurations. |
| AI Knowledge | Manage web and file knowledge sources, fetch markdown or links, and delete sources. |
The node builds requests from the fields you configure in the UI; some endpoints accept raw JSON for advanced bodies (for example JSON Patch or broadcast payloads). Refer to the Liveblocks REST API reference for request and response shapes.
Starts a workflow when Liveblocks sends a webhook to n8n. Configure the webhook URL from the trigger in your Liveblocks dashboard webhook settings. You can filter by event type or leave the filter empty to receive all supported types.
Supported event filters include: commentCreated, commentDeleted, commentEdited, notification, storageUpdated, threadCreated, threadDeleted, threadMetadataUpdated, userEntered, userLeft, yjsUpdate. The trigger verifies the request using your webhook signing secret before running the workflow.
- Create or open a project in the Liveblocks dashboard.
- Copy the secret key (
sk_…) from project settings. - In n8n, create a credential of type Liveblocks API and paste the secret key.
The credential test calls the REST API (for example listing rooms) to confirm the key works.
- In the Liveblocks dashboard, open your project’s webhook configuration and copy the signing secret (
whsec_…). - In n8n, create a credential of type Liveblocks Webhook Signing Secret API and paste that value.
This secret is only used to verify incoming webhook signatures; it is not validated with a live HTTP test in the credentials UI.
- This package declares
n8nNodesApiVersion1 inpackage.json, in line with current n8n community node conventions. - It lists
n8n-workflowas a peer dependency (version resolved by your n8n install).
Use a current n8n release that supports community nodes and API version 1. If you hit a compatibility issue, report it with your n8n version and this package version.
- Action node: Add Liveblocks, select resource and operation, then fill the parameters. Map data from previous nodes into room IDs, user IDs, and bodies as needed. Use Execute step while designing to inspect API responses and errors.
- Trigger: Add Liveblocks Trigger, set credentials, copy the webhook URL into the Liveblocks dashboard, and choose which events to listen for. Use n8n’s test URL while building, then switch to the production URL when the workflow is active.
- Errors: Failed API calls surface as n8n errors with HTTP status and message when the API returns them. If webhooks fail verification, check that the signing secret matches the project and that the request is actually from Liveblocks.
New to n8n? See Try it out in the n8n docs.
- n8n community nodes documentation
- Liveblocks documentation
- Liveblocks REST API reference
- Liveblocks webhooks
- Liveblocks dashboard
For local development of this repository, clone the project and use the n8n node CLI (n8n-node dev, n8n-node build) as described in the project’s contributor docs.
See CHANGELOG.md for a complete changelog.