--- meta: title: "Neon + Liveblocks" parentTitle: "Integrations" description: "Use Neon with Liveblocks when your collaborative app needs to store data in a Postgres database—for example mirrored collaboration data for reporting, search, audit logs, and workflows." --- [Neon](https://neon.tech/) provides serverless Postgres with branching and autoscaling. Using webhooks, you can set up one-way synchronization of your Liveblocks data to Neon for reporting, search, audit logs, or app workflows. ## How data sync works Liveblocks [webhooks](/docs/platform/webhooks) trigger when certain events happen, such as when a collaborative document updates. Liveblocks can trigger an endpoint in your back end, and from here, you can fetch the latest data and write it to Neon. Here’s an example of how it works with [Liveblocks Storage](/docs/collaboration-features/multiplayer/sync-engine/liveblocks-storage). ```mermaid sequenceDiagram actor User participant LB as Liveblocks app participant Webhook as Webhook endpoint participant Neon User->>LB: Edits document Note over LB: Throttle LB->>Webhook: **storageUpdated** webhook Webhook->>LB: **getStorageDocument** API LB-->>Webhook: Storage data Webhook->>Neon: Upsert row data Neon-->>Webhook: 200 OK ``` ## Which data can be synced? Various types of Liveblocks data can be synched to Neon with webhooks. | Name | Description | Relevant webhook | Relevant API | | ------------------------ | ------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Rooms | Created rooms and metadata. | [`roomUpdated`](/docs/platform/webhooks#RoomUpdatedEvent) | [`getRoom`](/docs/api-reference/liveblocks-node#get-rooms-roomId) | | Active users | Currently connected users. | [`userEntered`](/docs/platform/webhooks#UserEnteredEvent) | [`getActiveUsers`](/docs/api-reference/liveblocks-node#get-active-users) | | Liveblocks Storage | Custom realtime document state. | [`storageUpdated`](/docs/platform/webhooks#StorageUpdatedEvent) | [`getStorageDocument`](/docs/api-reference/liveblocks-node#get-rooms-roomId-storage) | | React Flow | Flowchart state. | [`storageUpdated`](/docs/platform/webhooks#StorageUpdatedEvent) | [`mutateFlow`](/docs/api-reference/liveblocks-react-flow#mutateFlow) | | Yjs | `Y.Doc` document state. | [`ydocUpdated`](/docs/platform/webhooks#YDocUpdatedEvent) | [`getYjsDocument`](/docs/api-reference/liveblocks-node#get-rooms-roomId-ydoc) | | Tiptap/BlockNote/Lexical | Text editor state. | [`ydocUpdated`](/docs/platform/webhooks#YDocUpdatedEvent) | [`getYjsDocument`](/docs/api-reference/liveblocks-node#get-rooms-roomId-ydoc) | | Threads | Comments, reactions, more. | [`threadCreated`](/docs/platform/webhooks#ThreadCreatedEvent) | [`getThread`](/docs/api-reference/liveblocks-node#get-rooms-roomId-threads-threadId) | This is not an exhaustive list—around [15 related webhook events](/docs/platform/webhooks#Liveblocks-events) are available, along with many [Node.js methods](/docs/api-reference/liveblocks-node), [Python functions](/docs/api-reference/liveblocks-python), and [REST API endpoints](/docs/api-reference/rest-api-endpoints). ## Setup Quickstart for synching Liveblocks data to Neon. In this example, we sync Liveblocks Storage data to Neon, but you can use the same pattern with other APIs and webhooks to sync other types of data. Create the Neon table Use one row for each Liveblocks room. ```sql create table liveblocks_documents ( room_id text primary key, data jsonb not null, updated_at timestamptz not null default now() ); ``` Create a webhook endpoint Add a back end endpoint in your app, for example at `/api/liveblocks-webhook`. ```ts export async function POST(request: Request) { const body = await request.json(); const headers = request.headers; // Verify the webhook event, then sync to Neon // ... return new Response(null, { status: 200 }); } ``` Subscribe to Storage updates In the [Liveblocks dashboard](/dashboard), navigate to the “Webhooks’ page inside a project, and create a webhook endpoint for your endpoint URL—this requires you to [host your local project](/docs/guides/how-to-test-webhooks-on-localhost). Subscribe to [`storageUpdated`](/docs/platform/webhooks#StorageUpdatedEvent), then copy the webhook secret. Verify the webhook event In your endpoint, using [`WebhookHandler`](/docs/api-reference/liveblocks-node#WebhookHandler), verify the webhook event with the webhook secret from the dashboard. ```ts import { WebhookHandler } from "@liveblocks/node"; const webhookHandler = new WebhookHandler( process.env.LIVEBLOCKS_WEBHOOK_SECRET! ); export async function POST(request: Request) { const body = await request.json(); const headers = request.headers; // Verify if this is a real webhook request // +++ let event; try { event = webhookHandler.verifyRequest({ headers: headers, rawBody: JSON.stringify(body), }); } catch (err) { console.error(err); return new Response("Could not verify webhook call", { status: 400 }); } // +++ // Sync to Neon // ... return new Response(null, { status: 200 }); } ``` Sync Storage to Neon Set up your Liveblocks and Neon clients, before fetching the Storage document data with [`getStorageDocument`](/docs/api-reference/rest-api-endpoints#get-rooms-roomId-storage) and upserting the Neon row with `on conflict … do update`. ```ts import { Liveblocks, WebhookHandler } from "@liveblocks/node"; import { neon } from "@neondatabase/serverless"; const liveblocks = new Liveblocks({ secret: process.env.LIVEBLOCKS_SECRET_KEY!, }); const sql = neon(process.env.DATABASE_URL!); const webhookHandler = new WebhookHandler( process.env.LIVEBLOCKS_WEBHOOK_SECRET! ); export async function POST(request: Request) { const body = await request.json(); const headers = request.headers; // Verify if this is a real webhook request let event; try { event = webhookHandler.verifyRequest({ headers: headers, rawBody: JSON.stringify(body), }); } catch (err) { console.error(err); return new Response("Could not verify webhook call", { status: 400 }); } // +++ if (event.type === "storageUpdated") { const { roomId } = event.data; // Get Storage document data const data = await liveblocks.getStorageDocument(roomId, "json"); // Upsert into Neon await sql` insert into liveblocks_documents (room_id, data, updated_at) values (${roomId}, ${JSON.stringify(data)}::jsonb, now()) on conflict (room_id) do update set data = excluded.data, updated_at = excluded.updated_at `; } // +++ return new Response(null, { status: 200 }); } ``` Data sync is set up! Your Liveblocks data is now automatically synched to Neon when the webhook event is fired. ## Limits and troubleshooting ### Storage or Yjs data is stale [`storageUpdated`](/docs/platform/webhooks#StorageUpdatedEvent) and [`ydocUpdated`](/docs/platform/webhooks#YDocUpdatedEvent) webhooks are throttled because collaborative documents can be modified up to 60 times per second. Treat Neon as an eventually consistent mirror, not as the live editing channel. ### Webhook verification fails Check that `LIVEBLOCKS_WEBHOOK_SECRET` is the webhook secret for the webhook endpoint that sent the event. Also make sure your endpoint passes the same raw body string to [`verifyRequest`](/docs/api-reference/liveblocks-node#verifyRequest) that it received from Liveblocks. ### Neon writes fail Keep `DATABASE_URL` on the server only. Use a role with permission to write the mirror tables. If you use Neon’s pooled connection string, follow Neon’s guidance for serverless and long-running workers. ### Duplicate writes happen Webhook deliveries can be retried. Use `on conflict … do update` upserts with a stable primary key such as `room_id`, `thread_id`, or `comment_id` so repeated deliveries update the same row. ### Liveblocks REST requests fail Check that `LIVEBLOCKS_SECRET_KEY` is a secret key from the same Liveblocks project as the room. If the request still fails, return a non-2xx response so the webhook can be retried. ## Related docs - [Supabase + Liveblocks](/docs/integrations/supabase). - API references for, [webhooks](/docs/platform/webhooks), [Node.js](/docs/api-reference/liveblocks-node), [Python](/docs/api-reference/liveblocks-python), and [REST API](/docs/api-reference/rest-api-endpoints). --- For an overview of all available documentation, see [/llms.txt](/llms.txt).