/* 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 */
}

#content-area {
  overflow: scroll !important;
}

th {
  text-align: left;
}


Threads

Messages

@Mentions

Attachments

Reactions

Status & Priority

Recordings

Deep Links

Access

Comment Sidebar

Comments

Velt Button

Core

Velt

Documentation

UI Customization

API Reference

Release Notes

Examples

Get API Key

API Event Types Enum

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

Customize Behavior

There are several options to send notifications to your users.

Comments Notifications

In-app Notifications

Setup

Inline Reactions

The Recorder allows your users to create audio, screen, and video recordings.

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.

Sync and broadcast data in real-time across all connected clients.

Redux Middleware

Allow only one user to edit at a time but still allow everyone to see the changes as they happen.

Replace component layout

Remove Components

Reorder Components

Themes

Remove Shadow DOM

Dark Mode

Use CSS Library

Use Custom CSS

Template Variables

Conditional Templates

Custom Action Components

Variants

This component is used to render the reaction tool and all the reactions.

Styling

Slots

Custom Button

Parts

Variables

Create Your Own UI

Comments Webhooks

Generating Auth Tokens

Generate JWT Tokens for additional security

JWT Tokens

Proxy Server

Add Organizations

Update Organizations

Delete Organizations

Get Organizations

Get Organizations v2

Update Disabled State for Organizations

Add Documents

Update Documents

Delete Documents

Get Documents

Get Documents v2

Update Access for Documents

Update Disabled State for Documents

Update Location

Delete all data associated with a specific location

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

Get Users v2

Add User Groups

Add Users to Groups

Delete Users from Groups

Add Notifications

Update Notifications

Delete Notifications

Get Notifications

Get Notifications v2

API Methods Index

React Hooks Index

API Request Objects

API Event Objects

Export Cord Data for Migration

AG Grid

Enum Name	Event Type	Description
`ADD_COMMENT_ANNOTATION`	`addCommentAnnotation`	Add a new comment annotation
`DELETE_COMMENT_ANNOTATION`	`deleteCommentAnnotation`	Delete a comment annotation

Enum Name	Event Type	Description
`ADD_COMMENT`	`addComment`	Add a new comment
`UPDATE_COMMENT`	`updateComment`	Update an existing comment
`DELETE_COMMENT`	`deleteComment`	Delete a comment

Enum Name	Event Type	Description
`ASSIGN_USER`	`assignUser`	Assign a user to a comment
`SUBSCRIBE_COMMENT_ANNOTATION`	`subscribeCommentAnnotation`	Subscribe to a comment annotation
`UNSUBSCRIBE_COMMENT_ANNOTATION`	`unsubscribeCommentAnnotation`	Unsubscribe from a comment annotation

Enum Name	Event Type	Description
`ADD_ATTACHMENT`	`addAttachment`	Add an attachment to a comment
`DELETE_ATTACHMENT`	`deleteAttachment`	Delete an attachment from a comment

Enum Name	Event Type	Description
`ADD_REACTION`	`addReaction`	Add a reaction to a comment
`DELETE_REACTION`	`deleteReaction`	Delete a reaction from a comment
`TOGGLE_REACTION`	`toggleReaction`	Toggle a reaction on a comment

Enum Name	Event Type	Description
`UPDATE_STATUS`	`updateStatus`	Update the status of a comment
`RESOLVE_COMMENT`	`resolveComment`	Resolve a comment
`UPDATE_PRIORITY`	`updatePriority`	Update the priority of a comment
`APPROVE_COMMENT_ANNOTATION`	`approveCommentAnnotation`	Approve a comment annotation
`ACCEPT_COMMENT_ANNOTATION`	`acceptCommentAnnotation`	Accept a comment annotation
`REJECT_COMMENT_ANNOTATION`	`rejectCommentAnnotation`	Reject a comment annotation

Enum Name	Event Type	Description
`COMMENT_SIDEBAR_DATA_INIT`	`commentSidebarDataInit`	Triggered when comment sidebar data is first loaded
`COMMENT_SIDEBAR_DATA_UPDATE`	`commentSidebarDataUpdate`	Triggered when comment sidebar data is updated

REST APIs

SDK

​Comments

​Threads

​Messages

​@Mentions

​Attachments

​Reactions

​Status & Priority

​Recordings

​Deep Links

​Access

​Comment Sidebar

​Core

​Velt Button