/* Hide scrollbar for Chrome, Safari and Opera */
::-webkit-scrollbar {
  display: none;
}

/* Hide scrollbar for IE, Edge and Firefox */
* {
  -ms-overflow-style: none;  /* IE and Edge */
  scrollbar-width: none;  /* Firefox */
}

Notification Class Properties

displayHeadlineMessageTemplateData Object Properties

NotificationMetadata Properties

Velt

Documentation

UI Customization

API Reference

Release Notes

Examples

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

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

There are several options to send notifications to your users.

Notifications

Provide a toggleable sidebar to view and filter comments.

Comments Sidebar

Setup

Customize Behavior

In-app Notifications

Inline Reactions

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

Recorder

View Analytics

Arrows

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.

Customize UI

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.

Replace component layout

Remove Components

Reorder Components

Remove Shadow DOM

Dark Mode

Use CSS Library

Use Custom CSS

Template Variables

Conditional Templates

Variants

General Setup

Comments Webhooks

Generating Auth Tokens

Generate JWT Tokens for additional security

JWT Tokens

Proxy Server

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

Update Location

How to Delete all Data by Location via an API call

Delete Data by Location

Add Users

Update Users

Remove Users from an Organization or a Document.

Delete Users

Delete All User Data (GDPR)

Get Users

Add User Groups

Add Users to Groups

Delete Users from Groups

Add Notifications

Update Notifications

Delete Notifications

Get Notifications

React Hooks

CommentAnnotation

CommentSelectionChangeData

CommentSidebarConfig

Velt Client Config

ContactListScopeForOrganizationUsers

CursorUser

CustomCss

CustomFilter

DocumentMetadata

EditorAccessTimer

FlockOptions

LiveStateData

LocationMetadata

MediaPreviewConfig

PageInfo

PresenceUser

RecorderAnnotation

RewriterAnnotation

SyncVideoPlayer

UserContactSelectedPayload

UserContactUs

UserFeedback

Export Cord Data for Migration

AG Grid

Property	Type	Optional	Description
`id`	`string`	No	Notification ID
`notificationSource`	`string`	No	Notification source. e.g., ‘comment’, ‘custom’, etc.
`actionType`	`string`	Yes	Action that triggered the notification. e.g., ‘added’
`isUnread`	`boolean`	Yes	Whether the notification is unread for the user
`actionUser`	`User`	Yes	The user who triggered the action
`timestamp`	`number`	Yes	Timestamp of the notification
`displayHeadlineMessage`	`string`	Yes	The headline message of the notification
`displayBodyMessage`	`string`	Yes	The body message of the notification
`displayHeadlineMessageTemplate`	`string`	Yes	The template of the headline message
`displayHeadlineMessageTemplateData`	`object`	Yes	The data used to fill the headline message template
`forYou`	`boolean`	Yes	Whether the notification is for the current logged-in user
`targetAnnotationId`	`string`	Yes	ID of the annotation that triggered the notification
`notificationSourceData`	`any`	Yes	The data of the notification source. e.g., `CommentAnnotation`
`metadata`	`NotificationMetadata`	Yes	Metadata for the current notification. e.g., `documentId`
`notifyUsers`	`{ [emailHash: string]: boolean }`	Yes	Map of email hashes to boolean values indicating whether to notify the user
`notifyUsersByUserId`	`{ [userIdHash: string]: boolean }`	Yes	Map of user ID hashes to boolean values indicating whether to notify the user

Property	Type	Description
`actionUser`	`User`	The user who performed the action
`recipientUser`	`User`	The user receiving the notification
`actionMessage`	`string`	The message describing the action
`project`	`string`	The project related to the notification
`[key: string]`	`any`	Any additional custom properties

Property	Type	Optional	Description
`apiKey`	`string`	Yes	Your API key
`clientOrganizationId`	`string`	Yes	The organization ID that you set
`organizationId`	`string`	Yes	The organization ID generated by us
`clientDocumentId`	`string`	Yes	The document ID that you set
`documentId`	`string`	Yes	The document ID generated by us
`locationId`	`number`	Yes	The unique location ID
`location`	`Location`	Yes	The location object
`documentMetadata`	Object	Yes	Contains the complete document metadata object
`organizationMetadata`	Object	Yes	Contains the complete organization metadata object

REST APIs

Reference

Notification

`Notification` Class Properties

`displayHeadlineMessageTemplateData` Object Properties

`NotificationMetadata` Properties

REST APIs

Reference

​Notification Class Properties

​displayHeadlineMessageTemplateData Object Properties

​NotificationMetadata Properties

`Notification` Class Properties

`displayHeadlineMessageTemplateData` Object Properties

`NotificationMetadata` Properties