​

Comments

​

Threads

​

AddCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata
addContext	(context: any) => void	Yes	Function to add custom metadata
elementRef	{ xpath: string }	No	Reference to DOM element where comment annotation was added

​

DeleteCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata

​

Messages

​

AddCommentEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
comment	Comment	Yes	Comment Object
metadata	VeltEventMetadata	Yes	Event metadata

​

UpdateCommentEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
comment	Comment	Yes	Comment Object
metadata	VeltEventMetadata	Yes	Event metadata

​

DeleteCommentEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
comment	Comment	Yes	Comment Object
metadata	VeltEventMetadata	Yes	Event metadata

​

@Mentions

​

AssignUserEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
assignedTo	UserContact	Yes	User being assigned
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	No	Event metadata

​

SubscribeCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata

​

UnsubscribeCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata

​

AutocompleteSearchEvent

---

Property	Type	Required	Description
event	KeyboardEvent | InputEvent | Event	Yes	The triggering event
searchText	string	Yes	The search text entered
type	'contact' | 'custom'	No	Type of autocomplete search. Whether is the @mentions or custom list
metadata	VeltEventMetadata	No	Event metadata

​

Custom List

​

AutocompleteSearchEvent

---

Property	Type	Required	Description
event	KeyboardEvent | InputEvent | Event	Yes	The triggering event
searchText	string	Yes	The search text entered
type	'contact' | 'custom'	No	Type of autocomplete search. Whether is the @mentions or custom list
metadata	VeltEventMetadata	No	Event metadata

​

Attachments

​

AddAttachmentEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
attachments	AddAttachmentResponse[]	Yes	Array of attachment responses
metadata	VeltEventMetadata	Yes	Event metadata

​

AddAttachmentResponse

---

Property	Type	Required	Description
valid	boolean	Yes	Whether attachment is valid
file	File	No	File object
maxAllowedSize	number	Yes	Maximum allowed file size
error	string	No	Error message if invalid
attachment	Attachment	No	Attachment object

​

DeleteAttachmentEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentId	number	Yes	ID of the comment
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
attachment	Attachment	Yes	Attachment Object
metadata	VeltEventMetadata	Yes	Event metadata

​

Reactions

​

AddReactionEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
reaction	ReactionAnnotation	Yes	Reaction Object
metadata	VeltEventMetadata	Yes	Event metadata

​

DeleteReactionEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
reaction	ReactionAnnotation	Yes	Reaction Object
metadata	VeltEventMetadata	Yes	Event metadata

​

ToggleReactionEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
reaction	ReactionAnnotation	Yes	Reaction Object
metadata	VeltEventMetadata	Yes	Event metadata

​

Status & Priority

​

UpdateStatusEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
newStatus	CustomStatus	Yes	New status object
oldStatus	CustomStatus	Yes	Previous status object
metadata	VeltEventMetadata	Yes	Event metadata

​

ResolveCommentEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata

​

UpdatePriorityEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
newPriority	CustomPriority	No	New Priority object
oldPriority	CustomPriority	No	Previous Priority object
metadata	VeltEventMetadata	Yes	Event metadata

​

ApproveCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata

​

AcceptCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata
actionUser	User	Yes	User who performed the action
replaceContentHtml	string	No	HTML content to replace with
replaceContentText	string	No	Text content to replace with

​

RejectCommentAnnotationEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
metadata	VeltEventMetadata	Yes	Event metadata
actionUser	User	Yes	User who performed the action
replaceContentHtml	string	No	HTML content to replace with
replaceContentText	string	No	Text content to replace with

​

Recordings

​

DeleteRecordingEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
commentId	number	Yes	ID of the comment
recording	RecordedData	Yes	Recording data
metadata	VeltEventMetadata	Yes	Event metadata

​

Deep Links

​

CopyLinkEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
link	string	Yes	Copied link
metadata	VeltEventMetadata	Yes	Event metadata

​

GetLinkResponse

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
link	string | null	Yes	Generated link
metadata	VeltEventMetadata	Yes	Event metadata

​

Access

​

UpdateAccessEvent

---

Property	Type	Required	Description
annotationId	string	Yes	ID of the annotation
commentAnnotation	CommentAnnotation	Yes	Comment annotation object
newAccessMode	CommentAccessMode	No	New access mode
oldAccessMode	CommentAccessMode	No	Previous access mode
metadata	VeltEventMetadata	Yes	Event metadata

​

UI

​

ComposerClickedEvent

---

Property	Type	Required	Description
commentAnnotation	CommentAnnotation	No	Comment annotation object. This is undefined if it’s a new comment annotation object.
metadata	VeltEventMetadata	Yes	Event metadata

​

Comment Sidebar

​

CommentSidebarDataInitEvent

---

Property	Type	Required	Description
buttonContext	VeltButtonContext	Yes	Button context
metadata	VeltEventMetadata	Yes	Event metadata
commentAnnotation	CommentAnnotation	No	Comment annotation object
comment	Comment	No	Comment object
index	number	No	Index value
commentAnnotations	CommentAnnotation[]	No	Array of comment annotations
systemFilteredAnnotations	CommentAnnotation[]	No	Filtered comment annotations
unreadCommentAnnotationsMap	{ [commentAnnotationId: string]: number }	No	Map of unread comment counts

​

CommentSidebarDataUpdateEvent

---

Property	Type	Required	Description
buttonContext	VeltButtonContext	Yes	Button context
metadata	VeltEventMetadata	Yes	Event metadata
commentAnnotation	CommentAnnotation	No	Comment annotation object
comment	Comment	No	Comment object
index	number	No	Index value
commentAnnotations	CommentAnnotation[]	No	Array of comment annotations
systemFilteredAnnotations	CommentAnnotation[]	No	Filtered comment annotations
unreadCommentAnnotationsMap	{ [commentAnnotationId: string]: number }	No	Map of unread comment counts

​

Recorder

​

RecordingDoneEvent

---

Property	Type	Required	Description
recorderId	string	Yes	ID of the recorder
from	User | null	No	The user who created the recorder
metadata	RecorderMetadata	No	Metadata for the recording
assets	RecorderDataAsset[]	Yes	Array of recording assets for the latest version
assetsAllVersions	RecorderDataAsset[]	Yes	Array of all versions of recording assets
transcription	RecorderDataTranscription	Yes	Transcription data for the recording

​

RecordingDeleteEvent

---

Property	Type	Required	Description
recorderId	string	Yes	ID of the recorder
from	User | null	No	The user who created the recorder
metadata	RecorderMetadata	No	Metadata for the recording
assets	RecorderDataAsset[]	Yes	Array of recording assets for the latest version
assetsAllVersions	RecorderDataAsset[]	Yes	Array of all versions of recording assets
transcription	RecorderDataTranscription	Yes	Transcription data for the recording

​

RecordingEditDoneEvent

---

Property	Type	Required	Description
recorderId	string	Yes	ID of the recorder
from	User | null	No	The user who created the recorder
metadata	RecorderMetadata	No	Metadata for the recording
assets	RecorderDataAsset[]	Yes	Array of recording assets for the latest version
assetsAllVersions	RecorderDataAsset[]	Yes	Array of all versions of recording assets
transcription	RecorderDataTranscription	Yes	Transcription data for the recording

​

RecordingSaveInitiatedEvent

---

Property	Type	Required	Description
annotationId	string	No	ID of the annotation. This property is only available when type is ‘edit’.
message	string	Yes	A descriptive message about the save initiation.
type	'edit' | 'record'	Yes	Specifies whether the save was initiated for an ‘edit’ or a new ‘recording’.

​

TranscriptionDoneEvent

---

Property	Type	Required	Description
recorderId	string	Yes	ID of the recorder
from	User | null	No	The user who created the recorder
metadata	RecorderMetadata	No	Metadata for the recording
assets	RecorderDataAsset[]	Yes	Array of recording assets for the latest version
assetsAllVersions	RecorderDataAsset[]	Yes	Array of all versions of recording assets
transcription	RecorderDataTranscription	Yes	Transcription data for the recording

​

RecordingErrorEvent

---

Property	Type	Required	Description
type	string	Yes	The type of error that occurred. eg: editFailed, recordingFailed, transcriptionFailed
message	string	Yes	A descriptive message about the error.
recorderId	string	No	ID of the recorder, if the error is specific to one.

​

Single Editor Mode

​

AccessRequestEvent

---

This event object is related to requests for editor access. It is emitted for accessRequested, accessRequestCanceled, accessAccepted, and accessRejected events.

Property	Type	Required	Description
viewer	User	No	The user who is the current viewer and is involved in the access request.
editor	User	No	The user who is the current editor at the time of the event.
timestamp	number	No	UNIX timestamp (in milliseconds) of when the event occurred.
status	string	No	The status of the access request (e.g., “requested”, “canceled”, “accepted”, “rejected” ).

​

SEMEvent

---

This event object is related to editor/viewer assignments and editor status changes. It is emitted for editorAssigned, viewerAssigned, and editorOnDifferentTabDetected events.

Property	Type	Required	Description
viewer	User	No	The user who is the current viewer at the time of the event.
editor	User	No	The user who is the current editor at the time of the event.
timestamp	number	No	UNIX timestamp (in milliseconds) of when the event occurred.
role	string	No	The role relevant to the event, typically “editor” or “viewer” for assignment events.

​

Presence

​

PresenceUserStateChangeEvent

---

This event object is emitted when a user’s online status changes to online.

Property	Type	Required	Description
user	PresenceUser	Yes	The current user’s Presence object.
state	string	Yes	The new presence state of the user (e.g., online, offline, away).

​

Client

​

DocumentInitEvent

---

• DocumentInitEvent can be of type: boolean | undefined
• This represents the document initialization status.

​

ErrorEvent

---

Property	Type	Required	Description
code	string	Yes	Error code
message	string	No	Error message

​

List of error codes:

Code	Description
token_expired	The JWT token has expired

​

UserUpdateEvent

---

• UserUpdateEvent will return data of type: User | null
• If there is no user, it will return null else it will return the user object.

​

VeltButtonClickEvent

---

Property	Type	Required	Description
buttonContext	VeltButtonContext	Yes	Button context
metadata	VeltEventMetadata	Yes	Event metadata
commentAnnotation	CommentAnnotation	No	Comment annotation object
comment	Comment	No	Comment object
index	number	No	Index of the repeated component the button is in. eg: Comment, Notification component.
commentAnnotations	CommentAnnotation[]	No	Array of comment annotations
systemFilteredAnnotations	CommentAnnotation[]	No	Filtered comment annotations
unreadCommentAnnotationsMap	{ [commentAnnotationId: string]: number }	No	Map of unread comment counts
notification	Notification	No	Notification object
notifications	Notification[]	No	Array of notifications