Liveblocks REST API allows developers to interact programmatically with their Liveblocks account and services using HTTP requests. With the API, developers can retrieve, set, and update room-related data, users, permissions, schemas, and more. The Liveblocks API is organized around REST.
The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
To use the API endpoints, you need to add your secret key to the request’s authorization header. Except for the public authorization endpoint.
AuthenticationThis endpoint lets your application server (your back end) obtain a token that one of its clients (your frontend) can use to enter a Liveblocks room. You use this endpoint to implement your own application’s custom authentication endpoint. When making this request, you’ll have to use your secret key.
Important: The difference with an ID token is that an access token holds all the permissions, and is the source of truth. With ID tokens, permissions are set in the Liveblocks back end (through REST API calls) and "checked at the door" every time they are used to enter a room.
Note: When using the @liveblocks/node package, you can use Liveblocks.prepareSession in your back end to build this request.
You can pass the property userId in the request’s body. This can be whatever internal identifier you use for your user accounts as long as it uniquely identifies an account. The property userId is used by Liveblocks to calculate your account’s Monthly Active Users. One unique userId corresponds to one MAU.
Additionally, you can set custom metadata to the token, which will be publicly accessible by other clients through the user.info property. This is useful for storing static data like avatar images or the user’s display name.
Lastly, you’ll specify the exact permissions to give to the user using the permissions field. This is done in an object where the keys are room names, or room name patterns (ending in a *), and a list of permissions to assign the user for any room that matches that name exactly (or starts with the pattern’s prefix). For tips, see Manage permissions with access tokens.
This endpoint lets your application server (your back end) obtain a token that one of its clients (your frontend) can use to enter a Liveblocks room. You use this endpoint to implement your own application’s custom authentication endpoint. When using this endpoint to obtain ID tokens, you should manage your permissions by assigning user and/or group permissions to rooms explicitly, see our Manage permissions with ID tokens section.
Important: The difference with an access token is that an ID token doesn’t hold any permissions itself. With ID tokens, permissions are set in the Liveblocks back end (through REST API calls) and "checked at the door" every time they are used to enter a room. With access tokens, all permissions are set in the token itself, and thus controlled from your back end entirely.
Note: When using the @liveblocks/node package, you can use Liveblocks.identifyUser in your back end to build this request.
You can pass the property userId in the request’s body. This can be whatever internal identifier you use for your user accounts as long as it uniquely identifies an account. The property userId is used by Liveblocks to calculate your account’s Monthly Active Users. One unique userId corresponds to one MAU.
If you want to use group permissions, you can also declare which groupIds this user belongs to. The group ID values are yours, but they will have to match the group IDs you assign permissions to when assigning permissions to rooms, see Manage permissions with ID tokens).
Additionally, you can set custom metadata to the token, which will be publicly accessible by other clients through the user.info property. This is useful for storing static data like avatar images or the user’s display name.
This endpoint returns a list of your rooms. The rooms are returned sorted by creation date, from newest to oldest. You can filter rooms by room ID prefixes, metadata, users accesses, and groups accesses. Corresponds to liveblocks.getRooms.
There is a pagination system where the cursor to the next page is returned in the response as nextCursor, which can be combined with startingAfter. You can also limit the number of rooms by query.
Filtering by metadata works by giving key values like metadata.color=red. Of course you can combine multiple metadata clauses to refine the response like metadata.color=red&metadata.type=text. Notice here the operator AND is applied between each clauses.
Filtering by groups or userId works by giving a list of groups like groupIds=marketing,GZo7tQ,product or/and a userId like userId=user1. Notice here the operator OR is applied between each groupIds and the userId.
limit optional
A limit on the number of rooms to be returned. The limit can range between 1 and 100, and defaults to 20.
startingAfter optional
A cursor used for pagination. Get the value from the nextCursor response of the previous page.
query optional
Query to filter rooms. You can filter by roomId and metadata, for example, metadata["roomType"]:"whiteboard" AND roomId^"liveblocks:engineering". Learn more about filtering rooms with query language.
userId optional
A filter on users accesses.
groupIds optional
A filter on groups accesses. Multiple groups can be used.
This endpoint creates a new room. id and defaultAccesses are required. When provided with a ?idempotent query argument, will not return a 409 when the room already exists, but instead return the existing room as-is. Corresponds to liveblocks.createRoom, or to liveblocks.getOrCreateRoom when ?idempotent is provided.
defaultAccessess could be [] or ["room:write"] (private or public).metadata could be key/value as string or string[]. metadata supports maximum 50 entries. Key length has a limit of 40 characters maximum. Value length has a limit of 256 characters maximum. metadata is optional field.usersAccesses could be [] or ["room:write"] for every records. usersAccesses can contain 100 ids maximum. Id length has a limit of 40 characters. usersAccesses is optional field.groupsAccesses are optional fields.This endpoint returns a room by its ID. Corresponds to liveblocks.getRoom.
roomId required
ID of the room
This endpoint updates specific properties of a room. Corresponds to liveblocks.updateRoom.
It’s not necessary to provide the entire room’s information. Setting a property to null means to delete this property. For example, if you want to remove access to a specific user without losing other users: { "usersAccesses": { "john": null } } defaultAccessess, metadata, usersAccesses, groupsAccesses can be updated.
defaultAccessess could be [] or ["room:write"] (private or public).metadata could be key/value as string or string[]. metadata supports maximum 50 entries. Key length has a limit of 40 characters maximum. Value length has a limit of 256 characters maximum. metadata is optional field.usersAccesses could be [] or ["room:write"] for every records. usersAccesses can contain 100 ids maximum. Id length has a limit of 256 characters. usersAccesses is optional field.groupsAccesses could be [] or ["room:write"] for every records. groupsAccesses can contain 100 ids maximum. Id length has a limit of 256 characters. groupsAccesses is optional field.roomId required
ID of the room
This endpoint deletes a room. A deleted room is no longer accessible from the API or the dashboard and it cannot be restored. Corresponds to liveblocks.deleteRoom.
roomId required
ID of the room
This endpoint updates specific properties of a room. Corresponds to liveblocks.upsertRoom.
It’s not necessary to provide the entire room’s information. Setting a property to null means to delete this property. For example, if you want to remove access to a specific user without losing other users: { "usersAccesses": { "john": null } } defaultAccessess, metadata, usersAccesses, groupsAccesses can be updated.
defaultAccessess could be [] or ["room:write"] (private or public).metadata could be key/value as string or string[]. metadata supports maximum 50 entries. Key length has a limit of 40 characters maximum. Value length has a limit of 256 characters maximum. metadata is optional field.usersAccesses could be [] or ["room:write"] for every records. usersAccesses can contain 100 ids maximum. Id length has a limit of 256 characters. usersAccesses is optional field.groupsAccesses could be [] or ["room:write"] for every records. groupsAccesses can contain 100 ids maximum. Id length has a limit of 256 characters. groupsAccesses is optional field.roomId required
ID of the room
This endpoint permanently updates the room’s ID.
ParametersroomId required
The new ID for the room
This endpoint returns a list of users currently present in the requested room. Corresponds to liveblocks.getActiveUsers.
For optimal performance, we recommend calling this endpoint no more than once every 10 seconds. Duplicates can occur if a user is in the requested room with multiple browser tabs opened.
ParametersroomId required
ID of the room
This endpoint enables the broadcast of an event to a room without having to connect to it via the client from @liveblocks/client. It takes any valid JSON as a request body. The connectionId passed to event listeners is -1 when using this API. Corresponds to liveblocks.broadcastEvent.
roomId required
ID of the room
Returns the contents of the room’s Storage tree. Corresponds to liveblocks.getStorageDocument.
The default outputted format is called “plain LSON”, which includes information on the Live data structures in the tree. These nodes show up in the output as objects with two properties, for example:
If you’re not interested in this information, you can use the simpler ?format=json query param, see below.
roomId required
ID of the room
format optional
Use ?format=json to output a simplified JSON representation of the Storage tree. In that format, each LiveObject and LiveMap will be formatted as a simple JSON object, and each LiveList will be formatted as a simple JSON array. This is a lossy format because information about the original data structures is not retained, but it may be easier to work with.
This endpoint initializes or reinitializes a room’s Storage. The room must already exist. Calling this endpoint will disconnect all users from the room if there are any, triggering a reconnect. Corresponds to liveblocks.initializeStorageDocument.
The format of the request body is the same as what’s returned by the get Storage endpoint.
For each Liveblocks data structure that you want to create, you need a JSON element having two properties:
"liveblocksType" => "LiveObject" | "LiveList" | "LiveMap""data" => contains the nested data structures (children) and data.The root’s type can only be LiveObject.
A utility function, toPlainLson is included in @liveblocks/client from 1.0.9 to help convert LiveObject, LiveList, and LiveMap to the structure expected by the endpoint.
roomId required
ID of the room
This endpoint deletes all of the room’s Storage data. Calling this endpoint will disconnect all users from the room if there are any. Corresponds to liveblocks.deleteStorageDocument.
roomId required
ID of the room
This endpoint returns a JSON representation of the room’s Yjs document. Corresponds to liveblocks.getYjsDocument.
roomId required
ID of the room
formatting optional
If present, YText will return formatting.
key optional
Returns only a single key’s value, e.g. doc.get(key).toJSON().
type optional
Used with key to override the inferred type, i.e. "ymap" will return doc.get(key, Y.Map).
This endpoint is used to send a Yjs binary update to the room’s Yjs document. You can use this endpoint to initialize Yjs data for the room or to update the room’s Yjs document. To send an update to a subdocument instead of the main document, pass its guid. Corresponds to liveblocks.sendYjsBinaryUpdate.
The update is typically obtained by calling Y.encodeStateAsUpdate(doc). See the Yjs documentation for more details. When manually making this HTTP call, set the HTTP header Content-Type to application/octet-stream, and send the binary update (a Uint8Array) in the body of the HTTP request. This endpoint does not accept JSON, unlike most other endpoints.
roomId required
ID of the room
guid optional
ID of the subdocument
This endpoint returns the room’s Yjs document encoded as a single binary update. This can be used by Y.applyUpdate(responseBody) to get a copy of the document in your back end. See Yjs documentation for more information on working with updates. To return a subdocument instead of the main document, pass its guid. Corresponds to liveblocks.getYjsDocumentAsBinaryUpdate.
roomId required
ID of the room
guid optional
ID of the subdocument
This endpoint creates a new schema which can be referenced later to enforce a room’s Storage data structure. Corresponds to liveblocks.createSchema.
The schema consists of a name (for referencing it), and a body, which specifies the exact allowed shape of data in the room. This body is a multi-line string written in the Liveblocks schema syntax.
This endpoint retrieves a schema by its ID. The ID is a combination of the schema name and version. For example, my-schema@1. Corresponds to liveblocks.getSchema.
id required
ID of the schema
This endpoint updates the body for the schema. A schema can only be updated if it is not used by any room. Corresponds to liveblocks.updateSchema.
id required
ID of the schema
This endpoint deletes a schema by its ID. The ID is a combination of the schema name and version. For example, my-schema@1. A schema can only be deleted if it is not attached to a room. Corresponds to liveblocks.deleteSchema.
id required
ID of the schema
This endpoint retrieves the schema attached to a room. Corresponds to liveblocks.getSchemaByRoomId.
roomId required
ID of the room
This endpoint attaches a schema to a room, and instantly enables runtime schema validation for the room. Corresponds to liveblocks.attachSchemaToRoom.
If the current contents of the room’s Storage do not match the schema, attaching will fail and the error message will give details on why the schema failed to attach.
ParametersroomId required
ID of the room
This endpoint returns the threads in the requested room. Corresponds to liveblocks.getThreads.
roomId required
ID of the room
query optional
Query to filter threads. You can filter by metadata and resolved, for example, metadata["status"]:"open" AND metadata["color"]:"red" AND resolved:true. Learn more about filtering threads with query language.
This endpoint creates a new thread and the first comment in the thread. Corresponds to liveblocks.createThread.
A comment’s body is an array of paragraphs, each containing child nodes. Here’s an example of how to construct a comment’s body, which can be submitted under comment.body.
roomId required
ID of the room
This endpoint returns a thread by its ID. Corresponds to liveblocks.getThread.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint deletes a thread by its ID. Corresponds to liveblocks.deleteThread.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint returns the list of thread participants. It is a list of unique user IDs representing all the thread comment authors and mentioned users in comments. Corresponds to liveblocks.getThreadParticipants.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint edits the metadata of a thread. The metadata is a JSON object that can be used to store any information you want about the thread, in string, number, or boolean form. Set a property to null to remove it. Corresponds to liveblocks.editThreadMetadata.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint marks a thread as resolved.
ParametersroomId required
ID of the room
threadId required
ID of the thread
This endpoint marks a thread as unresolved.
ParametersroomId required
ID of the room
threadId required
ID of the thread
This endpoint subscribes to a thread. Corresponds to liveblocks.subscribeToThread.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint unsubscribes from a thread. Corresponds to liveblocks.unsubscribeFromThread.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint gets the list of subscriptions to a thread. Corresponds to liveblocks.getThreadSubscriptions.
roomId required
ID of the room
threadId required
ID of the thread
This endpoint creates a new comment, adding it as a reply to a thread. Corresponds to liveblocks.createComment.
A comment’s body is an array of paragraphs, each containing child nodes. Here’s an example of how to construct a comment’s body, which can be submitted under body.
roomId required
ID of the room
threadId required
ID of the thread
get/rooms/:roomId/threads/:threadId/comments/:commentId
Get commentThis endpoint returns a comment by its ID. Corresponds to liveblocks.getComment.
roomId required
ID of the room
threadId required
ID of the thread
commentId required
ID of the comment
post/rooms/:roomId/threads/:threadId/comments/:commentId
Edit commentThis endpoint edits the specified comment. Corresponds to liveblocks.editComment.
A comment’s body is an array of paragraphs, each containing child nodes. Here’s an example of how to construct a comment’s body, which can be submitted under body.
roomId required
ID of the room
threadId required
ID of the thread
commentId required
ID of the comment
delete/rooms/:roomId/threads/:threadId/comments/:commentId
Delete commentThis endpoint deletes a comment. A deleted comment is no longer accessible from the API or the dashboard and it cannot be restored. Corresponds to liveblocks.deleteComment.
roomId required
ID of the room
threadId required
ID of the thread
commentId required
ID of the comment
This endpoint adds a reaction to a comment. Corresponds to liveblocks.addCommentReaction.
roomId required
ID of the room
threadId required
ID of the thread
commentId required
ID of the comment
This endpoint removes a comment reaction. A deleted comment reaction is no longer accessible from the API or the dashboard and it cannot be restored. Corresponds to liveblocks.removeCommentReaction.
roomId required
ID of the room
threadId required
ID of the thread
commentId required
ID of the comment
This endpoint returns a user’s inbox notification by its ID. Corresponds to liveblocks.getInboxNotification.
userId required
ID of the user
inboxNotificationId required
ID of the inbox notification
This endpoint deletes a user’s inbox notification by its ID.
ParametersuserId required
ID of the user
inboxNotificationId required
ID of the inbox notification
This endpoint deletes all the user’s inbox notifications.
ParametersuserId required
ID of the user
This endpoint returns all the user’s inbox notifications. Corresponds to liveblocks.getInboxNotifications.
userId required
ID of the user
query optional
Query to filter notifications. You can filter by unread, for example, unread:true.
limit optional
A limit on the number of inbox notifications to be returned. The limit can range between 1 and 50, and defaults to 50.
startingAfter optional
A cursor used for pagination. Get the value from the nextCursor response of the previous page.
This endpoint returns a user’s subscription settings for a specific room. Corresponds to liveblocks.getRoomSubscriptionSettings.
roomId required
ID of the room
userId required
ID of the user
This endpoint returns the list of a user's room subscription settings. Corresponds to liveblocks.getUserRoomSubscriptionSettings.
userId required
ID of the user
startingAfter optional
A cursor used for pagination. Get the value from the nextCursor response of the previous page.
limit optional
A limit on the number of elements to be returned. The limit can range between 1 and 50, and defaults to 50.
Deprecated. Prefer using access tokens or ID tokens instead. Read more in our migration guide.
This endpoint lets your application server (your back end) obtain a token that one of its clients (your frontend) can use to enter a Liveblocks room. You use this endpoint to implement your own application’s custom authentication endpoint. When making this request, you’ll have to use your secret key.
You can pass the property userId in the request’s body. This can be whatever internal identifier you use for your user accounts as long as it uniquely identifies an account. Setting the userId is optional if you want to use public rooms, but it is required to enter a private room (because permissions are assigned to specific user IDs). In case you want to use the group permission system, you can also declare which groupIds this user belongs to.
The property userId is used by Liveblocks to calculate your account’s Monthly Active Users. One unique userId corresponds to one MAU. If you don’t pass a userId, we will create for you a new anonymous userId on each connection, but your MAUs will be higher.
Additionally, you can set custom metadata to the token, which will be publicly accessible by other clients through the user.info property. This is useful for storing static data like avatar images or the user’s display name.
roomId required
ID of the room
Deprecated. When you update Liveblocks to 1.2, you no longer need to get a JWT token when using a public key.
This endpoint works with the public key and can be used client side. That means you don’t need to implement a dedicated authorization endpoint server side. The generated JWT token works only with public room (defaultAccesses: ["room:write"]).
roomId required
ID of the room
roomId required
ID of the room
userId required
ID of the user
roomId required
ID of the room
userId required
ID of the user
roomId required
ID of the room
userId required
ID of the user
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4