Velt

Release Notes

Community

Get API Key

Generating Auth Tokens

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 Location

Use multiple Locations at once

How to update a Location's object fields via an API call

Update Location API

How to Delete all Data by Location via an API call

Delete Data by Location API

Set up User groups and User contact lists to enable `Users` to `@mention `and tag eachother within `Comments`.

Setup

Replace an entire Group IDs contact list using a POST Method.

Create or Replace Contact List

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

Customize Behavior

Create your own comments using our Comment Thread component

Comment Thread

This process outlines the steps to add system comments as well as child system comments through the API.

Add System Comments

Delete System Comments

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 Concepts

General Setup

Webhooks

Comments Webhooks

Email Notifications

Generate JWT Tokens for additional security

Get Started

Documents and Locations

User Contacts List

Async Collaboration

Realtime Collaboration

In-App User Feedback

Permission Management

AI Copilot

UI Customization

Webhooks

Notifications

Security

API Reference

Generating Auth Tokens