Manage Liveblocks rooms, Storage, comments and threads, feeds, inbox notifications, notification settings and groups.
Explore 69 workflow actions for Liveblocks, including account permissions and operation limits.
25 read actions44 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add comment reaction
Write
This endpoint adds a reaction to a comment.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add group members
Write
This endpoint adds new members to an existing group.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Apply JSON Patch to Storage
Write
Applies a sequence of JSON Patch operations to the room's Storage document, useful for modifying Storage.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Broadcast event to a room
Write
This endpoint enables the broadcast of an event to a room without having to connect to it via the client from @liveblocks/client.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create comment
Write
This endpoint creates a new comment, adding it as a reply to a thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create feed
Write
This endpoint creates a new feed in a room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create feed message
Write
This endpoint creates a new message in a feed.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create group
Write
This endpoint creates a new group.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create room
Write
This endpoint creates a new room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create thread
Write
This endpoint creates a new thread and the first comment in the thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create version history snapshot
Write
This endpoint creates a new version history snapshot of the room, capturing both its Storage and Yjs documents.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a version
Write
This endpoint permanently deletes a version from the room's history.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete all inbox notifications
Write
This endpoint deletes all the user’s inbox notifications.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete comment
Write
This endpoint deletes a comment.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete feed
Write
This endpoint deletes a feed.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete feed message
Write
This endpoint deletes a feed message.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete group
Write
This endpoint deletes a group.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete inbox notification
Write
This endpoint deletes a user’s inbox notification by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete notification settings
Write
This endpoint deletes a user's notification settings for the project.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete room
Write
This endpoint deletes a room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete room subscription settings
Write
This endpoint deletes a user’s subscription settings for a specific room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Storage document
Write
This endpoint deletes all of the room’s Storage data.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete thread
Write
This endpoint deletes a thread by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit comment
Write
This endpoint edits the specified comment.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit comment metadata
Write
This endpoint edits the metadata of a comment.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit thread metadata
Write
This endpoint edits the metadata of a thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get active users
Read
This endpoint returns a list of users currently present in the requested room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get all inbox notifications
Read
This endpoint returns all the user’s inbox notifications.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get attachment
Read
An attachment's name, size and type (without its time-limited download URL).
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get comment
Read
This endpoint returns a comment by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get feed
Read
This endpoint returns a feed by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get feed messages
Read
This endpoint returns the messages in a feed.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get group
Read
This endpoint returns a specific group by ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get groups
Read
This endpoint returns a list of all groups in your project.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get inbox notification
Read
This endpoint returns a user’s inbox notification by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get notification settings
Read
This endpoint returns a user's notification settings for the project.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get room
Read
This endpoint returns a room by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get room feeds
Read
This endpoint returns the feeds in the requested room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get room subscription settings
Read
This endpoint returns a user’s subscription settings for a specific room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get room threads
Read
This endpoint returns the threads in the requested room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get rooms
Read
This endpoint returns a list of your rooms.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get Storage document
Read
Returns the contents of the room’s Storage tree.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get Storage file
Read
An uploaded Storage file's name, size and type (without its time-limited download URL).
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get thread
Read
This endpoint returns a thread by its ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get thread inbox notifications
Read
This endpoint returns the inbox notifications associated with a specific thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get thread subscriptions
Read
This endpoint gets the list of subscriptions to a thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get user groups
Read
This endpoint returns all groups that a specific user is a member of.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get user room subscription settings
Read
This endpoint returns the list of a user's room subscription settings.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get Version History
Read
This endpoint returns a list of version history snapshots for the room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Get Yjs document
Read
This endpoint returns a JSON representation of the room’s Yjs document.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Initialize Storage document
Write
This endpoint initializes or reinitializes a room’s Storage.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark inbox notification as read
Write
This endpoint marks a specific inbox notification as read.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark thread as resolved
Write
This endpoint marks a thread as resolved.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark thread as unresolved
Write
This endpoint marks a thread as unresolved.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Prewarm room
Read
Speeds up connecting to a room for the next 10 seconds.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
Remove comment reaction
Write
This endpoint removes a comment reaction.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove group members
Write
This endpoint removes members from an existing group.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set ephemeral presence
Write
This endpoint sets ephemeral presence for a user in a room without requiring a WebSocket connection.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Subscribe to thread
Write
This endpoint subscribes to a thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Trigger inbox notification
Write
This endpoint triggers an inbox notification.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unsubscribe from thread
Write
This endpoint unsubscribes from a thread.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update feed
Write
This endpoint updates the metadata of a feed.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update feed message
Write
This endpoint updates a feed message.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update notification settings
Write
This endpoint updates a user's notification settings for the project.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update room
Write
This endpoint updates specific properties of a room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update room ID
Write
This endpoint permanently updates the room’s ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update room organization ID
Write
This endpoint updates the room's organization ID.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update room subscription settings
Write
This endpoint updates a user’s subscription settings for a specific room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Upsert (update or create) room
Write
This endpoint updates specific properties of a room.
Permissions and limits
Account permissions
A Liveblocks project secret key (sk_)
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Liveblocks. A saved workflow is not a completed provider action.