User Class Properties

UserOptions Class Properties

Velt

Release Notes

Community

Get API Key

Quickstart for React. For other frameworks like `vue`, `angular`, `svelte`, `vanilla js` etc. check out the setup guide.

Quickstart

Steps to integrate Velt into an existing app

1. Install

Autheticate your logged in users with the SDK.

2. Authenticate

A Document is the space where you want your users to collaborate. For a design tool it's the canvas. For a video editor, it's the editor. For a documentation tool, it's the document etc. A document is like a virtual house. Users in the same virtual house can see and interact with each other.

3. Initialize Document

Advanced Setup Options

Set Document

Set Location

Use Multiple Locations at once

Remove Locations

Your users can add comments in context to ask questions, leave feedback, report bugs etc. We handle all complexity to ensure the comments are robust against content changes. We support many types of comment UX patterns as illustrated below.

Overview

Comments

Provide a toggleable sidebar to view and filter comments.

Comments Sidebar

Setup

Customize Behavior

Arrows

The Recorder allows your users to create audio, screen, and video recordings all with the click of a button.

Recorder

View Analytics

Notifications

This process outlines the steps to add custom notifications to our Notifications component through an API.

Add Custom Notification

Your users can see other users online on the document. This makes your app feel alive.

Your users can view each other's cursors when interacting on the same document. This makes your app more alive. We handle the complexity of adapting the cursors to different screen sizes, differences in content etc.

This is like Figma's follow along feature. Start a shared session in a click. One person is the leader, and whatever they do - like clicking, scrolling, or navigating - happens automatically on everyone else's screen.

Enable slack-style effortless audio, video and screen sharing discussions inside your own product. It even comes with built in chat.

Huddle Webhooks

Your users can see what part of the document others are interacting with in real-time.

Allow users to sync state across forms in different clients

Redux Middleware

Lock down forms or settings dashboards so only a single editor can edit at once.

A widget to invite others to collaborate together on a project

Invite

Let AI suggest improvements to your website text

Rewriter

General Setup

Email Notifications

Comments Webhooks

Add Organizations

Update Organizations

Delete Organizations

Get Organizations

Update Disabled State for Organizations

Add Documents

Update Documents

Delete Documents

Get Documents

Update Access for Documents

Update Disabled State for Documents

Add Users

Update Users

Remove Users from an Organization or a Document.

Delete Users

Get Users

Add User Groups

Add Users to Groups

Delete Users from Groups

Generating Auth Tokens

Generate JWT Tokens for additional security

Property	Type	Optional	Description
`userId`	string	No	Unique user identifier used to identify your user.
`name`	string	Yes	The full name of your user. Defaults to a random avatar name if not provided.
`photoUrl`	string	Yes	The display picture URL of your user. Defaults to a random avatar image if not provided.
`email`	string	Yes	Required for sending email or Slack notifications to users about comments and mentions.
`plan`	string	Yes	The product plan the user is on.
`organizationId`	string	Yes	Autogenerated organizationId based on the organizationId you provide.
`clientorganizationId`	string	Yes	The original organizationId provided by you.
`color`	string	Yes	A color assigned to the user for the current session, used for avatar border, live cursor, selection etc.
`textColor`	string	Yes	Used in the text color of the user’s intial when photoUrl is not present.
`type`	string	Yes	The type of user.
`isReadOnly`	boolean	Yes	Indicates if the user has read-only access.
`isAnonymous`	boolean	Yes	Indicates if the user is anonymous and can only view comments.
`isGuest`	boolean	Yes	Indicates if the user is a guest.
`groupId`	string	Yes	[DEPRECATED] A domain name or identifier used to cluster a group of users who work together.
`clientGroupId`	string	Yes	[DEPRECATED] The original groupId provided by the user.

Property	Type	Optional	Description
`replaceContacts`	boolean	Yes	If set to true, it will replace the user’s personal and group contacts with the ones provided.
`authToken`	string	Yes	The authentication token of the user.

Get Started

Key Concepts

Async Collaboration

Realtime Collaboration

In-App User Feedback

Permission Management

AI Copilot

UI Customization

Notifications

Webhooks

REST APIs

Security

API Reference

Migration

User

`User` Class Properties

`UserOptions` Class Properties

Get Started

Key Concepts

Async Collaboration

Realtime Collaboration

In-App User Feedback

Permission Management

AI Copilot

UI Customization

Notifications

Webhooks

REST APIs

Security

API Reference

Migration

​User Class Properties

​UserOptions Class Properties

`User` Class Properties

`UserOptions` Class Properties