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


List of Action Types

Webhook Data

Velt

Documentation

UI Customization

API Reference

Release Notes

Examples

Get API Key

Comments Webhooks

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

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

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

API Event Types Enum

Export Cord Data for Migration

AG Grid

Action Type	Description
`newlyAdded`	When the first comment in a thread is added
`added`	When a new comment is added. Not used for the first comment in a thread - see `newlyAdded`
`updated`	When an existing comment content gets updated
`deleted`	When an existing comments gets deleted
`approved`	When the comment is approved by the moderator. This is only applicable if you have turned on Moderator Mode.
`assigned`	When a comment gets assigned to a user
`statusChanged`	When a comment has its status changed (e.g. in progress, resolved, opened)
`priorityChanged`	When a comment has its priority changed (e.g. P0, P1, P2 or custom set priorities)
`accessModeChanged`	When a comment is changed from private to public or vice-versa
`accepted`	When a comment gets accepted by the moderator. This is only applicable if you have turned on Moderator Mode.
`rejected`	When a comment gets rejected by the moderator. This is only applicable if you have turned on Moderator Mode.
`reactionAdded`	When a reaction is added to a comment.
`reactionDeleted`	When a reaction is removed from a comment.
`subscribed`	When a user subscribes to a comment annotation using the option in the UI.
`unsubscribed`	When a user unsubscribes from a comment annotation using the option in the UI.

Field	Type	Required	Description
`webhookId`	string	Yes	The unique identifier for the webhook event.
`commentAnnotation`	CommentAnnotation	Yes	The target CommentAnnotation object on which the event happened.
`targetComment`	Comment	Optional	The target Comment object on which the event happened. This field will not be present if the event was at CommentAnnotation level. Eg: deleted the entire comment annotation, resolved comment, approved comment.
`actionType`	string	Yes	This can have the values listed above
`notificationSource`	string	Yes	Indicates the source of the notification
`actionUser`	string	Yes	Contains information about the user who performed the action, including their name, email, and user ID.
`metadata`	string	Yes	This field contains additional metadata related to the annotation, such as the API key, client document ID, document ID, and information about various locations where the annotation is associated with a web page.

Get Started

Key Concepts

Async Collaboration

Realtime Collaboration

Email Notifications

Webhooks

Security

Miscellaneous

Comments Webhooks

List of Action Types

Webhook Data

Get Started

Key Concepts

Async Collaboration

Realtime Collaboration

Email Notifications

Webhooks

Security

Miscellaneous

​List of Action Types

​Webhook Data

List of Action Types

Webhook Data