---
meta:
  title: "n8n nodes"
  parentTitle: "Tools"
  description:
    "Use Liveblocks n8n nodes to connect Liveblocks to your n8n workflow."
---

n8n is a workflow automation platform that allows you to build agents visually,
and you can install a set of Liveblocks nodes which you can use directly in your
workflow. Each Liveblocks
[REST API endpoint](/docs/api-reference/rest-api-endpoints) has a corresponding
n8n node, allowing you to create rooms, add messages to feeds, update
multiplayer state, and more.

<Figure>
  <video autoPlay loop muted playsInline height={720} width={1060}>
    <source src="/assets/n8n-nodes/n8n-nodes.mp4" type="video/mp4" />
  </video>
</Figure>

## Install

Install our nodes as a
[community node](https://docs.n8n.io/integrations/community-nodes/installation/)
in your n8n instance.

1. Open n8n and go to **Settings** → **Community nodes**.
2. Select **Install** and enter `n8n-nodes-liveblocks` as the npm package name.
3. Check **☑︎ I understand…** and click **Install**.

_Liveblocks_ and _Liveblocks Trigger_ will now appear in the node palette.

<Figure>
  <video autoPlay loop muted playsInline height={720} width={1060}>
    <source src="/assets/n8n-nodes/n8n-nodes-install.mp4" type="video/mp4" />
  </video>
</Figure>

## Operations

The package provides two nodes.

### Liveblocks (action node)

Calls the
[Liveblocks REST API](https://liveblocks.io/docs/api-reference/rest-api-endpoints).
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](https://liveblocks.io/docs/api-reference/rest-api-endpoints)
for request and response shapes.

### Liveblocks Trigger (webhook)

Starts a workflow when Liveblocks sends a **webhook** to n8n. Configure the
webhook URL from the trigger in your
[Liveblocks dashboard](https://liveblocks.io/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.

## Credentials

### Liveblocks API (required for the Liveblocks action node)

1. Create or open a project in the
   [Liveblocks dashboard](https://liveblocks.io/dashboard).
2. Copy the **secret key** (`sk_…`) from project settings.
3. 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.

### Liveblocks Webhook Signing Secret (required for Liveblocks Trigger)

1. In the Liveblocks dashboard, open your project’s **webhook** configuration
   and copy the **signing secret** (`whsec_…`).
2. 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.

## Compatibility

- This package declares **`n8nNodesApiVersion` 1** in `package.json`, in line
  with current n8n community node conventions.
- It lists **`n8n-workflow`** as a peer dependency (version resolved by your n8n
  install).

Use a [current n8n release](https://docs.n8n.io/release-notes/) that supports
community nodes and API version 1. If you hit a compatibility issue, report it
with your n8n version and this package version.

## Usage

- **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](https://docs.n8n.io/try-it-out/) in the n8n docs.

## Resources

- [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes).
- [REST API reference](/docs/api-reference/rest-api-endpoints).
- [Webhooks](/docs/platform/webhooks).
- [How to test webhooks on localhost](/docs/guides/how-to-test-webhooks-on-localhost).

## Source code

The source code is available in our
[GitHub repository](https://github.com/liveblocks/n8n-nodes-liveblocks).

---

For an overview of all available documentation, see [/llms.txt](/llms.txt).