Comments

Threads

CommentAnnotation


PropertyTypeRequiredDescription
annotationIdstringYesUnique identifier for the comment pin annotation. Auto generated
commentsComment[]YesThe list of all comments part of this annotation
commentCategoriesCustomCategory[]YesThe list of categories that this comment pin annotation belongs to
fromUserYesThe user who created this comment pin annotation
colorstringNoColor used for the comment pin annotation
resolvedbooleanNoWhether the comment annotation is marked resolved. Deprecated
inProgressbooleanNoWhether the comment annotation is marked as in progress. Deprecated
lastUpdatedanyNoTimestamp when the comment annotation was last updated. Auto generated
createdAtanyNoTimestamp when the comment annotation was created. Auto generated
positionCursorPosition | nullNoCursor position relative to the comment annotation
locationIdnumber | nullNoUnique location id generated from provided location
locationLocation | nullNoSet location to identify user on sub document
typestringNoType of the comment annotation
selectAllContentbooleanNoIf true, sets text comment annotation on all the text content
approvedbooleanNoWhether the comment annotation is approved
statusCustomStatusYesStatus of the comment annotation. Default: CommentAnnotationStatusMap.OPEN
annotationIndexnumberNoIndex of current annotation in the list
pageInfoPageInfoNoPage information related to the comment annotation
assignedToUserNoUser to whom the comment annotation is assigned
priorityCustomPriorityNoPriority level of the comment annotation
ghostCommentGhostComment | nullNoPlaceholder for a non-existing comment
contextanyNoCustom context data provided by the user
resolvedByUserIdstringNoID of the user who resolved the comment
subscribedUsersCommentAnnotationSubscribedUsersNoUsers who explicitly subscribe to the comment
unsubscribedUsersCommentAnnotationUnsubscribedUsersNoUsers who explicitly unsubscribe to the comment
multiThreadAnnotationIdstringNoID of the multithread annotation group it belongs to, if created in multithread mode
isDraftbooleanNoIndicates if the comment annotation is in draft state
customListCustomAnnotationDropdownItem[]NoCustom list of items for the comment annotation
targetElementIdstringNoID of the target element for the comment annotation if available

Enum

Enum NameEvent TypeDescription
ADD_COMMENT_ANNOTATIONaddCommentAnnotationAdd a new comment annotation
DELETE_COMMENT_ANNOTATIONdeleteCommentAnnotationDelete a comment annotation

AddCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata
addContext(context: any) => voidYesFunction to add custom metadata
elementRef{ xpath: string }NoReference to DOM element where comment annotation was added

DeleteCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata

CommentAnnotationSubscribedUsers


PropertyTypeRequiredDescription
userIdHashstringYesThe user ID of the subscribed user
userUserYesThe user object of the subscribed user
type'manual' | 'auto'YesManual: if the user used the UI option to subscribe; Auto: When the system automatically adds the user to the subscribed list. eg: when the user creates a comment annotation

CommentAnnotationUnsubscribedUsers


PropertyTypeRequiredDescription
userIdHashstringYesThe user ID of the unsubscribed user
userUserYesThe user object of the unsubscribed user
type'manual' | 'auto'YesManual: if the user used the UI option to unsubscribe; Auto: When the system automatically removes the user from the unsubscribed list. eg: when the comment where user was tagged is deleted

AddCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationCommentAnnotationYesComment annotation
optionsRequestOptionsNoRequest options

DeleteCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

CommentRequestQuery


PropertyTypeRequiredDescription
documentIdsstring[]YesArray of document IDs to query
locationIdsstring[]NoArray of location IDs to filter by
statusIdsstring[]NoArray of status IDs to filter by

GetCommentAnnotationsCountResponse


PropertyTypeRequiredDescription
dataRecord<string, CommentAnnotationsCount> | nullYesMap of document IDs to their comment counts. Null while loading

GetCommentAnnotationsResponse


PropertyTypeRequiredDescription
dataRecord<string, CommentAnnotation[]> | nullYesMap of document IDs to their annotations. Null while loading

FetchCommentAnnotationsRequest


PropertyTypeRequiredDescription
createdAfternumberNoFilter annotations created after this timestamp
createdBeforenumberNoFilter annotations created before this timestamp
updatedAfternumberNoFilter annotations updated after this timestamp
updatedBeforenumberNoFilter annotations updated before this timestamp
statusIdsstring[]NoFilter annotations by status IDs
order'asc' | 'desc'NoSort order for annotations
pageTokenstringNoToken for fetching next page of results
allDocumentsbooleanNoWhether to fetch annotations from all documents
pageSizenumberNoNumber of results per page
organizationIdstringNoOrganization ID to fetch annotations from
locationIdstringNoLocation ID to filter annotations by
documentIdsstring[]NoArray of specific document IDs to fetch from
folderIdstringNoFolder ID to fetch annotations from
resolvedBystringNoFilter comments by user who resolved the comment
userIdsstring[]NoFilter comments by comment annotation author
mentionedUserIdsstring[]NoFilter comments where provided users are tagged in the comment

FetchCommentAnnotationsResponse


PropertyTypeRequiredDescription
dataRecord<string, CommentAnnotation[]> | nullYesMap of document IDs to their annotations. Null while loading
nextPageTokenstringYesToken for fetching next page of results

GetCommentResolverRequest


PropertyTypeRequiredDescription
organizationIdstringYesOrganization ID to fetch comments from
commentAnnotationIdsstring[]NoArray of comment annotation IDs to fetch comments from
documentIdsstring[]NoArray of document IDs to fetch comments from
folderIdstringNoFolder ID to fetch comments from
allDocumentsbooleanNoWhether to fetch comments from all documents within the given folder

SaveCommentResolverRequest


PropertyTypeRequiredDescription
commentAnnotation{ [key: string]: PartialCommentAnnotation }YesMap of comment annotation data to save
metadataBaseMetadataNoAdditional metadata for the request. eg: apikey, organizationId, documentId, etc.
eventResolverActionsNoEvent name that caused the save request
commentIdstringNoID of the comment to save

DeleteCommentResolverRequest


PropertyTypeRequiredDescription
commentAnnotationIdstringYesID of the comment annotation to delete
metadataBaseMetadataNoAdditional metadata for the request. eg: apikey, organizationId, documentId, etc.
eventResolverActionsNoEvent name that caused the delete request

CustomAnnotationDropdownData


PropertyTypeRequiredDescription
type'multi' | 'single'YesThe type of the custom annotation dropdown
placeholderstringYesThe placeholder text for the dropdown. Defaults to ‘Select’
dataCustomAnnotationDropdownItem[]YesAn array of dropdown items

CustomAnnotationDropdownItem


PropertyTypeRequiredDescription
idstringYesThe unique identifier for the dropdown item
labelstringYesThe display text for the dropdown item

CommentRequestQuery


PropertyTypeRequiredDescription
documentIdsstring[]YesList of document IDs to query
locationIdsstring[]YesList of location IDs to filter
statusIdsstring[]YesList of status IDs to filter

GetCommentAnnotationsResponse


PropertyTypeRequiredDescription
dataRecord<string, CommentAnnotation[]>YesMap of document IDs to their comment annotations

CommentAnnotationsCount


PropertyTypeRequiredDescription
unreadnumberYesNumber of unread comments
totalnumberYesTotal number of comments

GetCommentAnnotationsCountResponse


PropertyTypeRequiredDescription
dataRecord<string, CommentAnnotationsCount>YesMap of document IDs to their comment counts

Messages

ENUMs

Enum NameEvent TypeDescription
ADD_COMMENTaddCommentAdd a new comment
UPDATE_COMMENTupdateCommentUpdate an existing comment
DELETE_COMMENTdeleteCommentDelete a comment

Comment


PropertyTypeRequiredDescription
commentIdnumberYesUnique identifier for the comment pin annotation. Auto generated.
type'text' | 'voice'YesThis determines the comment content type. Default is ‘text’.
commentTextstringYesThe actual text content of the comment.
commentHtmlstringNoSame comment text but formatted in HTML.
replaceContentHtmlstringNoHTML content to replace the comment text when user accepts the comment.
replaceContentTextstringNoText content to replace the comment text when user accepts the comment.
commentVoiceUrlstringNoURL of the voice recording for the comment, if available.
fromUserYesThe user who created this comment.
toUser[]NoList of users that were @mentioned in this comment.
lastUpdatedDateNoTimestamp of when this comment was last updated. Auto generated.
editedAtanyNoTimestamp of when this comment was edited. Auto generated.
createdAtanyNoTimestamp of when this comment was created. Auto generated.
isEditedbooleanNoWhether the comment has been edited. Auto generated.
status'added' | 'updated'YesStatus of the comment indicating whether it was newly added or updated.
attachmentsAttachment[]YesList of attachments associated with the comment.
recordersRecordedData[]YesList of recorded data associated with the comment.
reactionAnnotationIdsstring[]YesList of annotation IDs for reactions to the comment.
taggedUserContactsAutocompleteUserContactReplaceData[]YesList of users that were @mentioned in this comment with UI metadata.
customListAutocompleteReplaceData[]YesList of custom list items added to the comment.
isDraftbooleanYesWhether the comment is in draft state.

AddCommentEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
commentCommentYesComment Object
metadataVeltEventMetadataYesEvent metadata

UpdateCommentEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
commentCommentYesComment Object
metadataVeltEventMetadataYesEvent metadata

DeleteCommentEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
commentCommentYesComment Object
metadataVeltEventMetadataYesEvent metadata

AddCommentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentCommentYesComment object
assignedToUserNoAssigned user
optionsRequestOptionsNoRequest options

UpdateCommentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentCommentYesComment object
mergebooleanNoMerge comments
optionsRequestOptionsNoRequest options

DeleteCommentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
skipDeleteThreadConfirmationbooleanNoSkip delete confirmation
optionsRequestOptionsNoRequest options

GetCommentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

@Mentions

ENUMs

Enum NameEvent TypeDescription
ASSIGN_USERassignUserAssign a user to a comment
SUBSCRIBE_COMMENT_ANNOTATIONsubscribeCommentAnnotationSubscribe to a comment annotation
UNSUBSCRIBE_COMMENT_ANNOTATIONunsubscribeCommentAnnotationUnsubscribe from a comment annotation
AUTOCOMPLETE_SEARCHautocompleteSearchWhen user starts searching for a contact in the @mentions dropdown

AssignUserRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
assignedToUserContactYesUser to assign
optionsRequestOptionsNoRequest options

GetContactListResponse


PropertyTypeRequiredDescription
organizationUsersUser[]NoList of users in the organization
folderUsersUser[]NoList of users added to the folder
documentUsersUser[]NoList of users added to the document
userGroupsUserGroup[]NoList of user groups in the organization
updatedContactListUser[]NoList of contacts updated via updateContactList API

SubscribeCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

UnsubscribeCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

AutocompleteItem


PropertyTypeRequiredDescription
idstringYesUnique identifier
namestringYesName of the item
descriptionstringNoOptional description
iconobjectNoOptional icon information
icon.urlstringNoURL of the icon
linkstringNoLink associated with item

AutocompleteUserContactReplaceData


PropertyTypeRequiredDescription
textstringYesThe text displayed in the comment that represents the tagged user
userIdstringYesThe user ID of the tagged user
contactUserNoThe user object of the tagged user

AutocompleteReplaceData


PropertyTypeRequiredDescription
textstringYesThe text displayed in the comment that represents the custom item
customAutocompleteItemYesThe custom item object associated with this text

AutocompleteItem


PropertyTypeRequiredDescription
idstringYesUnique identifier for the autocomplete item
namestringYesName or label of the autocomplete item
descriptionstringNoAdditional description of the autocomplete item
icon{ url?: string }NoIcon associated with the autocomplete item
linkstringNoOptional link associated with the autocomplete item

AutocompleteData


PropertyTypeRequiredDescription
hotkeystringYesThe hotkey or trigger for this autocomplete data
descriptionstringNoOptional description of the autocomplete data
type'custom' | 'contact' | 'group'YesThe type of autocomplete data. Default is ‘custom’
dataAutocompleteItem[]YesAn array of AutocompleteItem objects

AssignUserEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
assignedToUserContactYesUser being assigned
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataNoEvent metadata

SubscribeCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata

UnsubscribeCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata

AutocompleteSearchEvent


PropertyTypeRequiredDescription
eventKeyboardEvent | InputEvent | EventYesThe triggering event
searchTextstringYesThe search text entered
type'contact' | 'custom'NoType of autocomplete search. Whether is the @mentions or custom list
metadataVeltEventMetadataNoEvent metadata

Custom List

ENUMs

Enum NameEvent TypeDescription
AUTOCOMPLETE_SEARCHautocompleteSearchWhen user starts searching for a list item in the custom list dropdown

AutocompleteSearchEvent


PropertyTypeRequiredDescription
eventKeyboardEvent | InputEvent | EventYesThe triggering event
searchTextstringYesThe search text entered
type'contact' | 'custom'NoType of autocomplete search. Whether is the @mentions or custom list
metadataVeltEventMetadataNoEvent metadata

Attachments

ENUMs

Enum NameEvent TypeDescription
ADD_ATTACHMENTaddAttachmentAdd an attachment to a comment
DELETE_ATTACHMENTdeleteAttachmentDelete an attachment from a comment

Attachment


PropertyTypeRequiredDescription
attachmentIdnumberYesUnique identifier for the attachment. Auto-generated
namestringNoFile name of the attachment
sizenumberNoFile size of the attachment
typestringNoFile type of the attachment
urlstringNoDownload URL of the attachment
thumbnailstringNoThumbnail image in base64 format
thumbnailWithPlayIconUrlstringNoURL of the thumbnail with a play icon overlay
metadataanyNoAdditional metadata of the attachment
mimeTypeanyNoMIME type of the attachment

AddAttachmentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
filesFile[]YesArray of files
optionsRequestOptionsNoRequest options

DeleteAttachmentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
attachmentIdnumberYesID of the attachment
optionsRequestOptionsNoRequest options

GetAttachmentRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
optionsRequestOptionsNoRequest options

AddAttachmentResponse


PropertyTypeRequiredDescription
validbooleanYesValidity status
fileFileNoFile object
maxAllowedSizenumberYesMax allowed size
errorstringNoError message
attachmentAttachmentNoAttachment object

DeleteAttachmentResolverRequest


PropertyTypeRequiredDescription
attachmentIdnumberYesID of the attachment
metadataAttachmentResolverMetadataNoAdditional metadata for the request. eg: apikey, organizationId, documentId, etc.
eventResolverActionsNoEvent that triggered the delete

SaveAttachmentResolverRequest


PropertyTypeRequiredDescription
attachmentResolverAttachmentYesAttachment object to save
metadataAttachmentResolverMetadataNoAdditional metadata for the request. eg: apikey, organizationId, documentId, etc.
eventResolverActionsNoEvent that triggered the save

AddAttachmentEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
attachmentsAddAttachmentResponse[]YesArray of attachment responses
metadataVeltEventMetadataYesEvent metadata

AddAttachmentResponse


PropertyTypeRequiredDescription
validbooleanYesWhether attachment is valid
fileFileNoFile object
maxAllowedSizenumberYesMaximum allowed file size
errorstringNoError message if invalid
attachmentAttachmentNoAttachment object

DeleteAttachmentEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
commentAnnotationCommentAnnotationYesComment annotation object
attachmentAttachmentYesAttachment Object
metadataVeltEventMetadataYesEvent metadata

Reactions

ENUMs

Enum NameEvent TypeDescription
ADD_REACTIONaddReactionAdd a reaction to a comment
DELETE_REACTIONdeleteReactionDelete a reaction from a comment
TOGGLE_REACTIONtoggleReactionToggle a reaction on a comment

AddReactionRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
reaction{ reactionId: string; customReaction?: ReactionItem; }YesReaction object with reactionId and optional customReaction
optionsRequestOptionsNoRequest options

DeleteReactionRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
reaction{ reactionId: string; customReaction?: ReactionItem; }YesReaction object with reactionId and optional customReaction
optionsRequestOptionsNoRequest options

ToggleReactionRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
reaction{ reactionId: string; customReaction?: ReactionItem; }YesReaction object with reactionId and optional customReaction
optionsRequestOptionsNoRequest options

ReactionItem


PropertyTypeRequiredDescription
urlstringNoURL of the reaction image
emojistringNoEmoji character

GetReactionResolverRequest


PropertyTypeRequiredDescription
organizationIdstringYesID of the organization to fetch reactions from
reactionAnnotationIdsstring[]NoArray of reaction annotation IDs to fetch reactions from
documentIdsstring[]NoArray of document IDs to fetch reactions from
folderIdstringNoID of the folder to fetch reactions from
allDocumentsbooleanNoWhether to get reactions from all documents within the given folder

SaveReactionResolverRequest


PropertyTypeRequiredDescription
reactionAnnotation{ [key: string]: PartialReactionAnnotation }YesMap of reaction annotation id to reaction annotation data
metadataBaseMetadataNoAdditional metadata for the request. eg: apikey, organizationId, documentId, etc.
eventResolverActionsNoEvent name that caused the save request

DeleteReactionResolverRequest


PropertyTypeRequiredDescription
reactionAnnotationIdstringYesID of the reaction annotation
metadataBaseMetadataNoAdditional metadata for the request. eg: apikey, organizationId, documentId, etc.
eventResolverActionsNoEvent name that caused the delete request

AddReactionEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
reactionReactionAnnotationYesReaction Object
metadataVeltEventMetadataYesEvent metadata

DeleteReactionEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
reactionReactionAnnotationYesReaction Object
metadataVeltEventMetadataYesEvent metadata

ToggleReactionEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
reactionReactionAnnotationYesReaction Object
metadataVeltEventMetadataYesEvent metadata

Status & Priority

ENUMs

Enum NameEvent TypeDescription
UPDATE_STATUSupdateStatusUpdate the status of a comment
RESOLVE_COMMENTresolveCommentResolve a comment
UPDATE_PRIORITYupdatePriorityUpdate the priority of a comment
APPROVE_COMMENT_ANNOTATIONapproveCommentAnnotationApprove a comment annotation
ACCEPT_COMMENT_ANNOTATIONacceptCommentAnnotationAccept a comment annotation
REJECT_COMMENT_ANNOTATIONrejectCommentAnnotationReject a comment annotation

UpdateStatusRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
statusCustomStatusYesStatus value
optionsRequestOptionsNoRequest options

ResolveCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

UpdatePriorityRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
priorityCustomPriorityNoPriority object
optionsRequestOptionsNoRequest options

ApproveCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

AcceptCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

RejectCommentAnnotationRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

CustomPriority


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom priority
colorstringYesColor associated with the custom priority
namestringYesName or label of the custom priority
lightColorstringNoLight color variant for the custom priority

CustomStatus


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom status
colorstringYesText and comment pin color associated with the custom status
namestringYesName or label of the custom status
typeStatusTypeYesType of the status (default, ongoing, or terminal)
lightColorstringNoBackground color on the status indicator for the custom status
iconUrlstringNoURL to an icon image for the custom status

UpdateStatusEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
newStatusCustomStatusYesNew status object
oldStatusCustomStatusYesPrevious status object
metadataVeltEventMetadataYesEvent metadata

ResolveCommentEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata

UpdatePriorityEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
newPriorityCustomPriorityNoNew Priority object
oldPriorityCustomPriorityNoPrevious Priority object
metadataVeltEventMetadataYesEvent metadata

ApproveCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata

AcceptCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata
actionUserUserYesUser who performed the action
replaceContentHtmlstringNoHTML content to replace with
replaceContentTextstringNoText content to replace with

RejectCommentAnnotationEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
metadataVeltEventMetadataYesEvent metadata
actionUserUserYesUser who performed the action
replaceContentHtmlstringNoHTML content to replace with
replaceContentTextstringNoText content to replace with

Recordings

ENUMs

Enum NameEvent TypeDescription
DELETE_RECORDINGdeleteRecordingDelete a recording from a comment

GetRecordingRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
optionsRequestOptionsNoRequest options

DeleteRecordingRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentIdnumberYesID of the comment
recorderIdstringYesID of the recorder
optionsRequestOptionsNoRequest options

DeleteRecordingEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
commentIdnumberYesID of the comment
recordingRecordedDataYesRecording data
metadataVeltEventMetadataYesEvent metadata

ENUMs

Enum NameEvent TypeDescription
COPY_LINKcopyLinkCopy a deep link to a comment

GetLinkRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

CopyLinkRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
optionsRequestOptionsNoRequest options

CopyLinkEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
linkstringYesCopied link
metadataVeltEventMetadataYesEvent metadata

GetLinkResponse


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
linkstring | nullYesGenerated link
metadataVeltEventMetadataYesEvent metadata

Access

ENUMs

Enum NameEvent TypeDescription
UPDATE_ACCESSupdateAccessUpdate access settings for a comment

UpdateAccessRequest


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
accessModeCommentAccessModeYesAccess mode
optionsRequestOptionsNoRequest options

UpdateAccessEvent


PropertyTypeRequiredDescription
annotationIdstringYesID of the annotation
commentAnnotationCommentAnnotationYesComment annotation object
newAccessModeCommentAccessModeNoNew access mode
oldAccessModeCommentAccessModeNoPrevious access mode
metadataVeltEventMetadataYesEvent metadata

UI

ENUMs

Enum NameEvent TypeDescription
COMPOSER_CLICKEDcomposerClickedTriggered when comment composer is clicked

ComposerClickedEvent


PropertyTypeRequiredDescription
commentAnnotationCommentAnnotationNoComment annotation object. This is undefined if it’s a new comment annotation object.
metadataVeltEventMetadataYesEvent metadata

Comment Sidebar

ENUMs

Enum NameEvent TypeDescription
COMMENT_SIDEBAR_DATA_INITcommentSidebarDataInitTriggered when comment sidebar data is first loaded
COMMENT_SIDEBAR_DATA_UPDATEcommentSidebarDataUpdateTriggered when comment sidebar data is updated

CommentStatus


PropertyTypeRequiredDescription
colorstringYesPrimary color for the status.
idstringYesUnique identifier for the status.
lightColorstringYesLight variant of the status color.
namestringYesDisplay name of the status.
svgstringYesSVG icon for the status.
typestringNoOptional type classification for the status.

CommentPriority


PropertyTypeRequiredDescription
colorstringYesPrimary color for the priority.
idstringYesUnique identifier for the priority.
lightColorstringYesLight variant of the priority color.
namestringYesDisplay name of the priority.

CustomFilter


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom filter
colorstringYesColor associated with the custom filter
namestringYesName or label of the custom filter

CustomCategory


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom category
colorstringYesColor associated with the custom category
namestringYesName or label of the custom category

CommentSidebarDataInitEvent


PropertyTypeRequiredDescription
buttonContextVeltButtonContextYesButton context
metadataVeltEventMetadataYesEvent metadata
commentAnnotationCommentAnnotationNoComment annotation object
commentCommentNoComment object
indexnumberNoIndex value
commentAnnotationsCommentAnnotation[]NoArray of comment annotations
systemFilteredAnnotationsCommentAnnotation[]NoFiltered comment annotations
unreadCommentAnnotationsMap{ [commentAnnotationId: string]: number }NoMap of unread comment counts
customFiltersCustomFiltersNoCustom filters applied in the Comment Sidebar. Only available when custom sidebar filters are used.

CommentSidebarDataUpdateEvent


PropertyTypeRequiredDescription
buttonContextVeltButtonContextYesButton context
metadataVeltEventMetadataYesEvent metadata
commentAnnotationCommentAnnotationNoComment annotation object
commentCommentNoComment object
indexnumberNoIndex value
commentAnnotationsCommentAnnotation[]NoArray of comment annotations
systemFilteredAnnotationsCommentAnnotation[]NoFiltered comment annotations
unreadCommentAnnotationsMap{ [commentAnnotationId: string]: number }NoMap of unread comment counts
customFiltersCustomFiltersNoCustom filters applied in the Comment Sidebar. Only available when custom sidebar filters are used.

CommentSidebarFilterConfig


PropertyTypeRequiredDescription
locationFilterTypeConfigNoConfiguration for the location filter type.
documentFilterTypeConfigNoConfiguration for the document filter type. Only use it if you are using multiple documents or folders
peopleFilterTypeConfigNoConfiguration for the author filter type.
taggedFilterTypeConfigNoConfiguration for the tagged/mentioned filter type.
assignedFilterTypeConfigNoConfiguration for the assigned filter type.
involvedFilterTypeConfigNoConfiguration for the involved filter type (author, mentioned, assigned).
priorityFilterTypeConfigNoConfiguration for the priority filter type.
categoryFilterTypeConfigNoConfiguration for the category filter type.
commentTypeFilterTypeConfigNoConfiguration for the comment type filter.
versionFilterTypeConfigNoConfiguration for the version filter type.
statusFilterTypeConfigNoConfiguration for the status filter type.
[key: string]FilterTypeConfig | undefinedNoCustom filter type configurations.

FilterTypeConfig


PropertyTypeRequiredDescription
namestringNoThe name of the filter type
enablebooleanNoEnables or disables the filter type
multiSelectionbooleanNoAllows multiple selections if set to true
enableGroupingbooleanNoEnables grouping within the filter type if set to true
placeholderstringNoThe placeholder text for the filter type. Used when filterOptionLayout is set to dropdown
idstringNoThe unique identifier for the filter type
type'custom' | 'system'NoThe type of filter - custom or system
optionsFilterOption[]NoArray of filter options available for this filter type

CommentSidebarGroupConfig


PropertyTypeRequiredDescription
enablebooleanNoEnables or disables grouping
namestringNoThe name of the group
[key: string]{ id?: string, name?: string }[] | string[] | undefinedNoCustom filter configurations

CommentSidebarFilters


PropertyTypeRequiredDescription
location{id: string}[]NoFilter by location Ids
document{id: string}[]NoFilter by document Ids
people{userId: string}[]NoFilter by author of comment annotation
tagged{userId: string}[]NoFilter by users who were tagged/mentioned in the comment
assigned{userId: string}[]NoFilter by users who were assigned to the comment annotation
involved{userId: string}[]NoFilter by users who are involved in the comment annotation (author, mentioned, assigned)
prioritystring[]NoFilter by priority ids
statusstring[]NoFilter by status ids
categorystring[]NoFilter by category ids
version{id: string}[]NoFilter by version Ids

CommentSidebarData


PropertyTypeRequiredDescription
groupIdstringNoID of the group. Defaults to ‘others’
groupNamestringNoName of the group. Defaults to ‘Others’
isExpandedbooleanNoWhether the group is expanded. Defaults to true
annotationsCommentAnnotation[]YesList of CommentAnnotations in the group

Options


PropertyTypeRequiredDescription
groupingbooleanNoWhether to group the data. Defaults to true

CustomFilterOption


PropertyTypeRequiredDescription
idstringYesUnique identifier for the filter option
namestringYesDisplay name for the filter option
selectedbooleanYesWhether the filter option is currently selected

CustomFilters


PropertyTypeRequiredDescription
[key: string]CustomFilterOption[]NoCustom filter configurations mapped by filter key

FilterOption


PropertyTypeRequiredDescription
idstringYesUnique identifier for the filter option
namestringYesDisplay name for the filter option

CustomFilter


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom filter.
colorstringYesColor associated with the custom filter.
namestringYesName or label of the custom filter.

CustomPriority


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom priority.
colorstringYesColor associated with the custom priority.
namestringYesName or label of the custom priority.
lightColorstringNoLight color variant for the custom priority.

CustomStatus


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom status.
colorstringYesColor associated with the custom status.
namestringYesName or label of the custom status.
typeStatusTypeYesType of the status (default, ongoing, or terminal).
lightColorstringNoLight color for the custom status.
iconUrlstringNoURL to an icon image for the custom status.

CustomCategory


PropertyTypeRequiredDescription
idstringYesUnique identifier for the custom category.
colorstringYesColor associated with the custom category.
namestringYesName or label of the custom category.

Recorder

Enum NameEvent TypeDescription
TRANSCRIPTION_DONEtranscriptionDoneTriggered when a transcription is generated and ready
RECORDING_DONErecordingDoneTriggered when a recording is completed
RECORDING_DELETEdeleteRecordingTriggered when a recording is deleted
RECORDING_EDIT_DONErecordingEditDoneTriggered when a recording is edited and saved
RECORDING_SAVE_INITIATEDrecordingSaveInitiatedTriggered when a recording saved is initiated
ERRORerrorTriggered when an error occurs during recording operations

Recorder Data

RecorderRequestQuery


PropertyTypeRequiredDescription
recorderIdsstring[]YesArray of recorder IDs to query

DeleteRecordingsRequest


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the latest version of the recording

GetRecordingDataResponse


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the latest version of the recording

DeleteRecordingsResponse


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the latest version of the recording

Recorder Configuration

RecorderQualityConstraints


PropertyTypeRequiredDescription
safariRecorderQualityConstraintsOptionsNoConstraints specific to the Safari browser.
otherRecorderQualityConstraintsOptionsNoConstraints for other browsers (e.g., Chrome, Firefox, Edge).

RecorderEncodingOptions


PropertyTypeRequiredDescription
safariMediaRecorderOptionsNoEncoding options specific to the Safari browser.
otherMediaRecorderOptionsNoEncoding options for other browsers (e.g., Chrome, Firefox, Edge).

RecordingDoneEvent


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the recording

RecordingDeleteEvent


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the recording

RecordingEditDoneEvent


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the recording

RecordingSaveInitiatedEvent


PropertyTypeRequiredDescription
annotationIdstringNoID of the annotation. This property is only available when type is ‘edit’.
messagestringYesA descriptive message about the save initiation.
type'edit' | 'record'YesSpecifies whether the save was initiated for an ‘edit’ or a new ‘recording’.

RecordingStartedEvent


PropertyTypeRequiredDescription
type'audio' | 'video' | 'screen'YesThe type of recording that started.

RecordingPausedEvent


PropertyTypeRequiredDescription
type'audio' | 'video' | 'screen'YesThe type of recording that was paused.

RecordingResumedEvent


PropertyTypeRequiredDescription
type'audio' | 'video' | 'screen'YesThe type of recording that was resumed.

RecordingCancelledEvent


PropertyTypeRequiredDescription
type'audio' | 'video' | 'screen'YesThe type of recording that was cancelled.

RecordingStoppedEvent


PropertyTypeRequiredDescription
type'audio' | 'video' | 'screen'YesThe type of recording that was stopped.

TranscriptionDoneEvent


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the recording

RecordingErrorEvent


PropertyTypeRequiredDescription
typestringYesThe type of error that occurred. eg: editFailed, recordingFailed, transcriptionFailed
messagestringYesA descriptive message about the error.
recorderIdstringNoID of the recorder, if the error is specific to one.

RecorderConfig


PropertyTypeRequiredDescription
type{ audio?: boolean, video?: boolean, screen?: boolean }YesTypes of media to be recorded
recorderOptionsMediaRecorderOptionsNoOptions for the media recorder

RecordedData


PropertyTypeRequiredDescription
idstringYesAnnotation ID of recorder annotation
tagstringYesRecorder player tag containing recorder annotation id which can be added anywhere on the DOM
typestringYesType of recorded data. Possible values are ‘audio’, ‘video’, and ‘screen’
thumbnailUrlstringNoURL of the thumbnail image for the recorded data
thumbnailWithPlayIconUrlstringNoURL of the thumbnail image with a play icon overlay
videoUrlstringNoURL of the recorded video
audioUrlstringNoURL of the recorded audio
videoPlayerUrlstringNoURL of the hosted website to open video in a new tab
getThumbnailTagfunctionYesA method that returns an HTML string for displaying the thumbnail with a link to the video player

RecorderAnnotation


PropertyTypeRequiredDescription
annotationIdStringYesUnique identifier for the recorder annotation, automatically generated.
fromUserYesThe user who created the recorder annotation.
colorStringNoColor used for the annotation.
lastUpdatedAnyNoTimestamp of the last update, automatically generated.
locationIdNumberNoUnique location ID from provided location.
locationLocationNoLocation to identify user on sub document.
typeStringNoType of annotation.
recordingTypeStringYesType of recording for the annotation.
modeStringYesMode of the recorder annotation, ‘floating’ or ‘thread’.
approvedBooleanNoIndicates if the annotation is approved.
attachmentAttachmentNoAttachment for recorded media. Deprecated.
attachmentsAttachment[]YesList of attachments for the annotation.
annotationIndexNumberNoIndex of the annotation in a list.
pageInfoPageInfoNoInformation about the page where the annotation is made.
recordedTimeObjectNoRecorded time details.
transcriptionTranscriptionNoTranscription of the recorded media.

RecorderDataTranscriptSegment


PropertyTypeRequiredDescription
startTimeStringYesStart time of the transcription segment
endTimeStringYesEnd time of the transcription segment
startTimeInSecondsNumberYesStart time of the segment in seconds
endTimeInSecondsNumberYesEnd time of the segment in seconds
textStringYesTranscribed text content of the segment

RecorderDataTranscription


PropertyTypeRequiredDescription
transcriptSegmentsRecorderDataTranscriptSegment[]NoArray of transcription segments
vttFileUrlStringNoURL to the VTT format transcription file
contentSummaryStringNoSummary of the transcribed content

RecorderDataAsset


PropertyTypeRequiredDescription
versionnumberNoVersion of the asset.
urlstringYesURL to the recorded media
mimeTypestringNoMIME type of the recorded media
fileNamestringNoName of the recorded file
fileSizeInBytesnumberNoFile size in bytes
fileFormatRecorderFileFormatNoThe format/extension of the file. Example: ‘mp3’, ‘mp4’, ‘webm’
thumbnailUrlstringNoURL to the thumbnail image
transcriptionRecorderDataTranscriptionNoTranscription data for the recording

RecorderData


PropertyTypeRequiredDescription
recorderIdstringYesID of the recorder
fromUser | nullNoThe user who created the recorder
metadataRecorderMetadataNoMetadata for the recording
assetsRecorderDataAsset[]YesArray of recording assets for the latest version
assetsAllVersionsRecorderDataAsset[]YesArray of all versions of recording assets
transcriptionRecorderDataTranscriptionYesTranscription data for the latest version of the recording

MediaPreviewConfig


PropertyTypeRequiredDescription
audioObjectNoConfiguration for audio preview
audio.enabledbooleanNoWhether audio preview is enabled
audio.deviceIdstringNoDevice ID for audio input
videoObjectNoConfiguration for video preview
video.enabledbooleanNoWhether video preview is enabled
video.deviceIdstringNoDevice ID for video input
screenObjectNoConfiguration for screen preview
screen.enabledbooleanNoWhether screen preview is enabled
screen.streamMediaStreamNoMediaStream for screen sharing

MediaRecorderOptions


PropertyTypeRequiredDescription
audioBitsPerSecondnumberNoControls the audio encoding quality by setting the number of bits used per second for audio.
videoBitsPerSecondnumberNoControls the video encoding quality by setting the number of bits used per second for video.

RecorderQualityConstraintsOptions


PropertyTypeRequiredDescription
videoMediaTrackConstraintsNoSpecifies the constraints for the video track.
audioMediaTrackConstraintsNoSpecifies the constraints for the audio track.

MediaTrackConstraints


PropertyTypeRequiredDescription
aspectRatioConstrainDoubleNoControls the width-to-height ratio of the captured video stream.
frameRateConstrainDoubleNoDetermines the number of frames per second for the video stream.
heightConstrainULongNoSets the vertical resolution (in pixels) of the video stream.
widthConstrainULongNoSets the horizontal resolution (in pixels) of the video stream.
autoGainControlConstrainBooleanNoEnables/disables automatic volume adjustment for audio input.
echoCancellationConstrainBooleanNoEnables/disables the removal of audio echo effects.
noiseSuppressionConstrainBooleanNoEnables/disables the filtering of background noise from audio.
sampleRateConstrainULongNoControls the number of audio samples taken per second.

ConstrainDouble


PropertyTypeRequiredDescription
minnumberNoThe minimum acceptable value.
maxnumberNoThe maximum acceptable value.
idealnumberNoThe preferred value that the browser will try to match if possible.
exactnumberNoA mandatory value that must be matched exactly or the request fails.

ConstrainULong


PropertyTypeRequiredDescription
minnumberNoThe minimum acceptable value.
maxnumberNoThe maximum acceptable value.
idealnumberNoThe preferred value that the browser will try to match if possible.
exactnumberNoA mandatory value that must be matched exactly or the request fails.

ConstrainBoolean


PropertyTypeRequiredDescription
idealbooleanNoThe preferred value that the browser will try to match if possible.
exactbooleanNoA mandatory value that must be matched exactly or the request fails.

Notifications

Notification


PropertyTypeRequiredDescription
idstringYesNotification ID
notificationSourcestringYesNotification source. e.g., ‘comment’, ‘custom’, etc.
actionTypestringNoAction that triggered the notification. e.g., ‘added’
isUnreadbooleanNoWhether the notification is unread for the user
actionUserUserNoThe user who triggered the action
timestampnumberNoTimestamp of the notification
displayHeadlineMessagestringNoThe headline message of the notification
displayBodyMessagestringNoThe body message of the notification
displayHeadlineMessageTemplatestringNoThe template of the headline message
displayHeadlineMessageTemplateDataobjectNoThe data used to fill the headline message template
forYoubooleanNoWhether the notification is for the current logged-in user
targetAnnotationIdstringNoID of the annotation that triggered the notification
notificationSourceDataanyNoThe data of the notification source. e.g., CommentAnnotation
metadataNotificationMetadataNoMetadata for the current notification. e.g., documentId
notifyUsers{ [emailHash: string]: boolean }NoMap of email hashes to boolean values indicating whether to notify the user
notifyUsersByUserId{ [userIdHash: string]: boolean }NoMap of user ID hashes to boolean values indicating whether to notify the user

NotificationMetadata


PropertyTypeRequiredDescription
apiKeystringNoYour API key
clientOrganizationIdstringNoThe organization ID that you set
organizationIdstringNoThe organization ID generated by us
clientDocumentIdstringNoThe document ID that you set
documentIdstringNoThe document ID generated by us
locationIdnumberNoThe unique location ID
locationLocationNoThe location object
documentMetadataObjectNoContains the complete document metadata object
organizationMetadataObjectNoContains the complete organization metadata object

SettingsUpdatedEvent


PropertyTypeRequiredDescription
settingsNotificationSettingsConfigYesThe updated notification settings configuration.
isMutedAllbooleanYesWhether all notifications are muted.
Enum NameEvent TypeDescription
SETTINGS_UPDATEDsettingsUpdatedTriggered when the notification settings are updated

NotificationSettingsConfig


Sets what notifications the user will receive on the provided channel.
PropertyTypeRequiredDescription
[key: string]NotificationSettingsItemTypeNoDynamic key-value pairs for notification settings configuration. The key represents the channel ID and the value represents the one of the NotificationSettingsItemType.

NotificationSettingsItemType


Decides what notifications the user will receive on the current channel. Type: 'ALL' | 'MINE' | 'NONE' | string Description:
  • ALL: Subscribes the user to all notifications whether or not the user is involved in the notification on the current document.
  • MINE: Subscribes the user to notifications that are related to the current user on the current document.
  • NONE: Subscribes the user to no notifications on this channel on the current document.

NotificationInitialSettingsConfig


PropertyTypeRequiredDescription
namestringNoDisplay name for the notification channel.
idstringYesUnique channel ID for the notification channel.
defaultstringNoDefault value for the notification channel.
enablebooleanNoWhether the notification channel is enabled.
valuesNotificationConfigValue[]NoArray of possible values for the notification channel.

NotificationConfigValue


PropertyTypeRequiredDescription
idNotificationSettingsItemTypeYesUnique id for the configuration value.
namestringNoDisplay name for the configuration value.

GetNotificationsDataQuery


PropertyTypeRequiredDescription
type'all' | 'forYou' | 'documents'NoFilter for notification type: all, for you, or documents.

Single Editor Mode

AccessRequestEvent


This event object is related to requests for editor access. It is emitted for accessRequested, accessRequestCanceled, accessAccepted, and accessRejected events.
PropertyTypeRequiredDescription
viewerUserNoThe user who is the current viewer and is involved in the access request.
editorUserNoThe user who is the current editor at the time of the event.
timestampnumberNoUNIX timestamp (in milliseconds) of when the event occurred.
statusstringNoThe 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.
PropertyTypeRequiredDescription
viewerUserNoThe user who is the current viewer at the time of the event.
editorUserNoThe user who is the current editor at the time of the event.
timestampnumberNoUNIX timestamp (in milliseconds) of when the event occurred.
rolestringNoThe role relevant to the event, typically “editor” or “viewer” for assignment events.

SingleEditorLiveStateData


PropertyTypeRequiredDescription
editorUser | nullNoThe user who is currently editing, if any
requestEditorAccessObject | nullNoDetails about a request for editor access
tabIdstring | nullNoThe identifier of the tab, if applicable

RequestEditorAccess


PropertyTypeRequiredDescription
userUserYesThe user requesting editor access
requestedAtanyYesThe timestamp when the access was requested
status'pending' | 'accepted' | 'rejected' | 'cancelled'YesThe status of the access request
editorAccessTimeoutnumberYesTimeout duration for the editor access
tabIdstring | nullNoThe identifier of the tab related to the access request

SingleEditorConfig


PropertyTypeRequiredDescription
customModebooleanNoEnables/disables custom mode. In custom mode, input elements are not disabled for the viewer
singleTabEditorbooleanYesEnables/disables editor mode on a single tab only

UserEditorAccess


PropertyTypeRequiredDescription
isEditorbooleanNoIndicates whether the user has editor privileges
isEditorOnCurrentTabbooleanNoIndicates whether the user is an editor on the current tab

EditorAccessTimer


PropertyTypeRequiredDescription
state'idle' | 'inProgress' | 'completed'YesThe state of the Editor Access Request timer
durationLeftnumberNoDuration left for the editor access timer to be completed.

Live State Data

LiveStateData


PropertyTypeRequiredDescription
idstringYesA unique identifier likely used for quick reference and indexing. It’s an MD5 hash of liveStateDataId
liveStateDataIdstringYesA unique identifier for the state data being synced
datastring | number | boolean | JSONYesThe actual data you want to synchronize across clients
lastUpdatedanyYesA timestamp or similar data indicating the last time the state data was updated
updatedByUserYesThe user who last updated the state data
tabIdstring | nullNoAn identifier that could be used to associate the state data with a specific tab or instance

LiveStateDataMap


PropertyTypeRequiredDescription
custom{ [liveStateDataId: string]: LiveStateData; }NoMap of all unique LiveStateData set by you on the given document.
defaultObjectNoMap of all unique LiveStateData set by the default editor on the given document.
default.singleEditorSingleEditorLiveStateDataNoPart of default, representing single editor live state data.
default.autoSyncStateObjectPart of default, representing auto synchronization state.
default.autoSyncState.currentLiveStateDataNoPart of autoSyncState, current live state data.
default.autoSyncState.history[liveStateDataId: string]: LiveStateDataNoPart of autoSyncState, map of historical live state data keyed by live state data ID.

LiveStateData


PropertyTypeRequiredDescription
idstringYesUnique identifier for the live state data
locationNamestringYesName of the location
versionVersionYesVersion information
[key: string]anyYesAdditional dynamic properties

SetLiveStateDataConfig


PropertyTypeRequiredDescription
mergebooleanNoWhether to merge data with existing data. Default is false.

ServerConnectionState


PropertyTypeRequiredDescription
ONLINEstringYesServer connection is online and active. Value: ‘online’
OFFLINEstringYesServer connection is offline. Value: ‘offline’
PENDING_INITstringYesServer connection initialization is pending. Value: ‘pendingInit’
PENDING_DATAstringYesServer is waiting for data. Value: ‘pendingData’

Client

Enums

Enum NameEvent TypeDescription
VELT_BUTTON_CLICKveltButtonClickTriggered when a Velt Button is clicked
USER_UPDATEuserUpdateTriggered when the Velt user is updated
DOCUMENT_INITdocumentInitTriggered when the Velt document is initialized
ERRORerrorTriggered when an error occurs. Currently this is only triggered for token_expired error. In future, this will be extended for other relevant errors.

DocumentMetadata


PropertyTypeRequiredDescription
documentIdstringYesUnique document id generated from client document id
documentNamestringNoDisplay name of the document
folderIdstringNoID of the folder containing this document
apiKeystringNoAPI key associated with the document
organizationIdstringYesOrganization ID that owns this document
locations{ [locationId: number]: LocationMetadata }NoLocation metadata for this document

Folders

FetchFoldersRequest


PropertyTypeRequiredDescription
organizationIdstringYesOrganization ID to fetch folders from
folderIdstringNoParent folder ID to fetch child folders from

FetchFoldersResponse


PropertyTypeRequiredDescription
dataRecord<string, FolderMetadata> | nullYesMap of folder IDs to their metadata. Null while loading
nextPageTokenstringYesToken for fetching next page of results

Documents

FetchDocumentsRequest


PropertyTypeRequiredDescription
organizationIdstringYesOrganization ID to fetch documents from
documentIdsstring[]NoArray of specific document IDs to fetch
folderIdstringNoFolder ID to fetch documents from
allDocumentsbooleanNoWhether to fetch all documents from folder

FetchDocumentsResponse


PropertyTypeRequiredDescription
dataRecord<string, DocumentMetadata> | nullYesMap of document IDs to their metadata. Null while loading
nextPageTokenstringYesToken for fetching next page of results. Default page size is 1000.

DocumentInitEvent


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

ErrorEvent


PropertyTypeRequiredDescription
codestringYesError code
messagestringNoError message

List of error codes:

CodeDescription
token_expiredThe 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


PropertyTypeRequiredDescription
buttonContextVeltButtonContextYesButton context
metadataVeltEventMetadataYesEvent metadata
commentAnnotationCommentAnnotationNoComment annotation object
commentCommentNoComment object
indexnumberNoIndex of the repeated component the button is in. eg: Comment, Notification component.
commentAnnotationsCommentAnnotation[]NoArray of comment annotations
systemFilteredAnnotationsCommentAnnotation[]NoFiltered comment annotations
unreadCommentAnnotationsMap{ [commentAnnotationId: string]: number }NoMap of unread comment counts
notificationNotificationNoNotification object
notificationsNotification[]NoArray of notifications
customFiltersCustomFiltersNoCustom filters applied in the Comment Sidebar. Only available when custom sidebar filters are used and when the button is in the sidebar.

Config

PropertyTypeRequiredDescription
urlAllowListstring[]NoRestricts Velt features to specific pages by specifying partial URL strings.
featureAllowListFeatureType[]NoOnly allows the provided Velt features to run.
userPlanAllowListstring[]NoRestricts Velt features to specific user plans.
userIdAllowListstring[]NoRestricts Velt features to specific users.
usePrefersColorSchemebooleanNoIf set to true, listens to changes on the prefers-color-scheme media query to set the global theme of Velt components.

Features


PropertyTypeRequiredDescription
AREA'area'NoArea feature for drawing areas/rectangles
ARROW'arrow'NoArrow feature for drawing arrows
AUDIO_HUDDLE'audioHuddle'NoAudio huddle feature for voice conversations
COMMENT'comment'NoComment feature for adding comments
CURSOR'cursor'NoCursor feature for showing user cursors
HUDDLE'huddle'NoHuddle feature for video conversations
LIVE_STATE_SYNC'liveStateSync'NoLive state sync feature
PRESENCE'presence'NoPresence feature for showing online users
TAG'tag'NoTag feature for adding tags
RECORDER'recorder'NoRecorder feature for recording sessions
REWRITER'rewriter'NoRewriter feature for text rewriting
LIVE_SELECTION'liveSelection'NoLive selection feature for showing user selections

VeltEventMetadata


PropertyTypeRequiredDescription
organizationMetadataOrganizationMetadata | nullNoOrganization metadata
documentMetadataDocumentMetadata | nullNoDocument metadata
locationLocation | nullNoLocation information

VeltButtonContext


PropertyTypeRequiredDescription
type'button' | 'button-toggle' | 'multi-select' | 'single-select'NoType of button (default: ‘button’)
groupIdstringNoID of the button group
selectionsVeltButtonSelectionMapNoMap of button selections grouped by button groupIds. For buttons without a group, the groupdId will be ‘ungrouped’
clickedButtonIdstringNoID of the clicked button

VeltButtonSelectionMap


PropertyTypeRequiredDescription
[groupId: string]{ [buttonId: string]: boolean }NoMap of button selections for a group

UpdateLocationsRequest


PropertyTypeRequiredDescription
organizationIdstringNoUnique identifier for the organization.
documentIdsstring[]NoArray of document IDs to update locations for.
locationsUpdateLocationMetadata<T>[]NoArray of location metadata objects to update.

UpdateLocationMetadata


PropertyTypeRequiredDescription
idstringYesUnique identifier for the location.
[key: string]`Tstring`NoAdditional custom properties for the location metadata.

UpdateDocumentsRequest


PropertyTypeRequiredDescription
organizationIdstringNoUnique identifier for the organization.
folderIdstringNoUnique identifier for the folder.
documentsUpdateDocumentMetadata<T>[]NoArray of document metadata objects to update.

UpdateDocumentMetadata


PropertyTypeRequiredDescription
documentIdstringYesUnique identifier for the document.
[key: string]`Tstring`NoAdditional custom properties for the document metadata.

Metadata


PropertyTypeRequiredDescription
apiKeystringYesAPI key associated with the event.
pageInfoPageInfoYesInformation about the page where the event occurred.
folderIdstringNoUnique identifier for the folder.
locationsobjectYesObject containing location data indexed by location ID.
documentDocumentMetadataNoDocument metadata associated with the event.
organizationOrganizationMetadataNoOrganization metadata associated with the event.
[key: string]anyNoAdditional custom properties.

DocumentMetadata


PropertyTypeRequiredDescription
documentIdstringYesUnique identifier for the document.
documentNamestringNoName of the document.
organizationIdstringNoUnique identifier for the organization.
folderIdstringNoUnique identifier for the folder.
[key: string]anyNoAdditional custom properties.

OrganizationMetadata


PropertyTypeRequiredDescription
organizationIdstringYesUnique identifier for the organization.
[key: string]anyNoAdditional custom properties.

PageInfo


PropertyTypeRequiredDescription
baseUrlstringYesBase URL of the page.
pathstringYesPath of the page.
queryParamsstringNoQuery parameters of the page URL.
titlestringYesTitle of the page.
urlstringYesFull URL of the page.

VeltAuthTokenRequest


PropertyTypeRequiredDescription
apiKeystringYesAPI Key. Must be provided, cannot be empty or whitespace only.
userIdstringYesUser ID. Must be provided, cannot be empty or whitespace only.
userPropertiesUserPropertiesNoAdditional user information to embed in the auth token. See below for details.
permissions{ resources: Resource[] }NoPermissions configuration. Defines what resources the user can access and their access levels. If not provided, defaults to no resource access.

UserProperties


PropertyTypeRequiredDescription
isAdminbooleanNoWhether the user is an admin.
namestringNoUser’s display name. If provided, cannot be empty or whitespace only.
emailstringNoUser’s email address. If provided, cannot be empty and must be a valid email format.
[key: string]anyNoAllows flexibility for custom user attributes.

Permissions


PropertyTypeRequiredDescription
resourcesResource[]NoArray of resources the user has permission to access. Defaults to empty array if not set.

Resource


Each resource represents something the user can access (organization, folder, or document).
PropertyTypeRequiredDescription
type'organization' | 'folder' | 'document'YesResource type. Must be one of: ‘organization’, ‘folder’, or ‘document’. Determines the scope and level of access.
idstringYesUnique identifier for the specific resource. Cannot be whitespace only. For organization: the organization ID. For folder: the folder ID. For document: the document ID.
organizationIdstringConditionallyOrganization ID. Required for folder and document types. Optional for organization type. Must be provided and non-empty for folder/document resources. Links the resource to a specific organization.
expiresAtnumberNoExpiration timestamp (Unix timestamp). If provided, must be a positive integer, greater than the current time, and a valid number. Used for temporary access grants.

BaseMetadata


PropertyTypeRequiredDescription
apiKeystringNoAPI key associated with the request.
documentIdstringNoUnique identifier for the document.
organizationIdstringNoUnique identifier for the organization.
folderIdstringNoUnique identifier for the folder.

Document


PropertyTypeRequiredDescription
idstringYesUnique identifier for the document
metadataDocumentMetadataYesMetadata associated with the document

SetDocumentsRequestOptions


PropertyTypeRequiredDescription
organizationIdstringNoOrganization ID for the documents
folderIdstringNoSubscribe to all or provided documents in the given folder
locationIdstringNoFilter and subscribe to document data for a specific location
allDocumentsbooleanNoSubscribe to all documents in the folder. Use this when folderId is provided
rootDocumentIdstringNoThe unique identifier of the root document. Used to specify the root document when multiple documents are subscribed.

FolderMetadata


PropertyTypeRequiredDescription
folderIdstringNoUnique identifier for the folder
parentFolderIdstringNoID of the parent folder
folderNamestringNoDisplay name of the folder
createdAtnumberNoTimestamp when folder was created
lastUpdatednumberNoTimestamp when folder was last updated
apiKeystringNoAPI key associated with the folder
organizationIdstringNoOrganization ID that the folder belongs to

CustomCss


PropertyTypeRequiredDescription
type’link’ | ‘styles’YesThe type of custom CSS, either a link to a CSS file or inline styles.
valuestringYesThe value of the custom CSS, either a URL or CSS styles.

LocationMetadata


PropertyTypeRequiredDescription
locationIdnumberNoUnique location id generated from client location information
locationLocation | nullNoLocation object provided by a client

SetLocationsRequestOptions


PropertyTypeRequiredDescription
rootLocationIdstringNoRoot location.
appendLocationbooleanNoMerge locations.

Location

PropertyTypeRequiredDescription
idstringNoUnique identifier for the location.
locationNamestringNoName of the location.
versionVersionNoVersion information provided by the user.
[key: string]anyNoAdditional dynamic properties for the location.

Self Hosting

PartialReactionAnnotation


PropertyTypeRequiredDescription
annotationIdstringYesID of the reaction annotation
metadataBaseMetadataNoAdditional metadata
iconstringNoIcon for the reaction

ResolverActions


An enum that defines the different types of actions that can trigger resolver events.
NameValueDescription
COMMENT_ANNOTATION_ADD'comment_annotation.add'Triggered when a new comment annotation is added
COMMENT_ANNOTATION_DELETE'comment_annotation.delete'Triggered when a comment annotation is deleted
COMMENT_ADD'comment.add'Triggered when a new comment is added to an annotation
COMMENT_DELETE'comment.delete'Triggered when a comment is deleted from an annotation
COMMENT_UPDATE'comment.update'Triggered when a comment is updated
REACTION_ADD'reaction.add'Triggered when a reaction is added to a comment
REACTION_DELETE'reaction.delete'Triggered when a reaction is removed from a comment
ATTACHMENT_ADD'attachment.add'Triggered when an attachment is added to a comment
ATTACHMENT_DELETE'attachment.delete'Triggered when an attachment is deleted from a comment

PartialComment


PropertyTypeRequiredDescription
commentIdstring | numberYesUnique identifier for the comment
commentHtmlstringNoHTML content of the comment
commentTextstringNoPlain text content of the comment
attachments{ [attachmentId: number]: PartialAttachment }NoMap of attachment IDs to partial attachment data

PartialCommentAnnotation


PropertyTypeRequiredDescription
annotationIdstringYesID of the comment annotation
metadataBaseMetadataNoAdditional metadata
commentsRecord<string, PartialComment>YesMap of comment IDs to partial comments data

PartialAttachment


PropertyTypeRequiredDescription
urlstringYesURL of the attachment
namestringYesName of the attachment
attachmentIdnumberYesUnique identifier for attachment

ResolverAttachment


PropertyTypeRequiredDescription
attachmentIdnumberYesUnique identifier for attachment
fileFileYesFile to be uploaded
namestringNoFile name
metadataAttachmentResolverMetadataNoMetadata of the attachment
mimeTypestringNoMime type of the attachment

AttachmentResolverMetadata


PropertyTypeRequiredDescription
organizationIdstring | nullYesID of the organization
documentIdstring | nullYesID of the document
folderIdstring | nullNoID of the folder
attachmentIdnumber | nullYesID of the attachment
commentAnnotationIdstring | nullYesID of the comment annotation
apiKeystring | nullYesAPI key for authentication

VeltDataProvider


PropertyTypeRequiredDescription
commentCommentAnnotationDataProviderNoProvider for comment annotation data
userUserDataProviderNoProvider for user data
reactionReactionAnnotationDataProviderNoProvider for reaction annotation data
attachmentAttachmentDataProviderNoProvider for file attachment data

ResolverConfig


PropertyTypeRequiredDescription
resolveTimeoutnumberNoTimeout duration (in milliseconds) for resolver operations
saveRetryConfigRetryConfigNoRetry configuration for save operations
deleteRetryConfigRetryConfigNoRetry configuration for delete operations
getRetryConfigRetryConfigNoRetry configuration for get operations. Currently not supported for UserDataProvider.
resolveUsersConfigResolveUsersConfigNoConfiguration for resolving users

ResolverResponse


PropertyTypeRequiredDescription
dataTNoResponse data of generic type T
successbooleanYesWhether the operation was successful
messagestringNoResponse message
timestampnumberNoTimestamp of the response
statusCodenumberYesHTTP status code of the response

RetryConfig


PropertyTypeRequiredDescription
retryCountnumberNoNumber of retry attempts
retryDelaynumberNoDelay between retry attempts in milliseconds
revertOnFailurebooleanNoWhether to revert changes on failure

ResolveUsersConfig


PropertyTypeRequiredDescription
organizationbooleanNoWhether to resolve organization users
folderbooleanNoWhether to resolve folder users
documentbooleanNoWhether to resolve document users

CommentAnnotationDataProvider


PropertyTypeRequiredDescription
get(request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>YesFunction to fetch comment annotations
save(request: SaveCommentResolverRequest) => Promise<ResolverResponse<T>>YesFunction to save comment annotations
delete(request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>YesFunction to delete comment annotations
configResolverConfigNoConfiguration for the data provider

ReactionAnnotationDataProvider


PropertyTypeRequiredDescription
get(request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>YesFunction to fetch reaction annotations
save(request: SaveReactionResolverRequest) => Promise<ResolverResponse<T>>YesFunction to save reaction annotations
delete(request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>YesFunction to delete reaction annotations
configResolverConfigNoConfiguration for the data provider

UserDataProvider


PropertyTypeRequiredDescription
get(userIds: string[]) => Promise<Record<string, User>>YesFunction to fetch user data by user IDs
configResolverConfigNoConfiguration for the data provider

AttachmentDataProvider


PropertyTypeRequiredDescription
save(request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>YesFunction to save attachment data
delete(request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>YesFunction to delete attachment data
configResolverConfigNoConfiguration for the data provider

SaveAttachmentResolverData


PropertyTypeRequiredDescription
urlstringYesURL of the saved attachment

Presence

PresenceUser


PropertyTypeRequiredDescription
userIdstringYesUnique user identifier
namestringNoUser’s full name (Default: Random avatar name)
emailstringNoUser’s email address
photoUrlstringNoUser’s display picture URL (Default: Random avatar image)
onlineStatusstringYesOnline status (active, away, offline) (Auto generated)
colorstringNoAssigned color for the user (Auto generated)
timestampanyYesServer Timestamp
typestringNoUser type
selectionsanyNoUser selections
documentParamsIdnumber | nullNoDeprecated unique document params ID
documentParamsobject | nullNoDeprecated document params
locationIdnumber | nullNoUnique location ID
locationLocation | nullNoLocation of user on sub document
isReadOnlybooleanNoIndicates if user is readonly
isAnonymousbooleanNoIf user can only view comments (Anonymous)
pageInfoPageInfoYesInformation about the page
isUserIdlebooleanNoIndicates if user is idle. This is based on the inactivityTime configured in the Presence feature. (Auto generated)
isTabAwaybooleanNoIndicates if user’s tab is unfocused. (Auto generated)

PresenceUserStateChangeEvent


This event object is emitted when a user’s online status changes to online.
PropertyTypeRequiredDescription
userPresenceUserYesThe current user’s Presence object.
statestringYesThe new presence state of the user (e.g., online, offline, away).

ENUMs

Enum NameEvent TypeDescription
USER_STATE_CHANGEuserStateChangeTriggered when a user’s online status changes to online, offline, or away

PresenceRequestQuery


PropertyTypeRequiredDescription
documentIdstringNoID of the document to query presence for.
organizationIdstringNoID of the organization to query presence for.
statusesstring[]NoArray of user statuses to filter by (e.g., ['online', 'away', 'offline']).

GetPresenceDataResponse


PropertyTypeRequiredDescription
dataPresenceUser[] | nullYesArray of PresenceUser objects. null while loading.

Webhooks

WebhookV2Payload


PropertyTypeRequiredDescription
eventstringYesThe event type that triggered the webhook.
actionTypestringYesThe specific action that occurred.
sourcestringYesThe source of the event.
dataCommentPayload | HuddlePayloadYesThe payload data containing event-specific information.
webhookIdstringYesUnique identifier for the webhook.

WebhookV2PayloadEncoded


PropertyTypeRequiredDescription
encodedPayloadstringYesBase64 encoded webhook payload.

WebhookV2PayloadEncrypted


PropertyTypeRequiredDescription
encryptedDatastringYesEncrypted webhook data.
encryptedKeystringYesEncrypted encryption key.
ivstringYesInitialization vector for decryption.

CommentPayload


PropertyTypeRequiredDescription
commentAnnotationCommentAnnotationNoThe comment annotation associated with the event.
targetCommentCommentNoThe target comment for the event.
actionUserUserNoThe user who performed the action.
metadataMetadataNoAdditional metadata about the event context.
oldStatusCommentStatusNoPrevious status of the comment (for status change events).
newStatusCommentStatusNoNew status of the comment (for status change events).
newPriorityCommentPriorityNoNew priority of the comment (for priority change events).

HuddlePayload


PropertyTypeRequiredDescription
actionUserUserNoThe user who performed the action.
metadataMetadataNoAdditional metadata about the event context.

Misc

RequestOptions


PropertyTypeRequiredDescription
documentIdstringNoDocument ID

CommentSelectionChangeData


PropertyTypeRequiredDescription
selectedbooleanYesWhether a comment is selected
annotationCommentAnnotationYesObject data of the selected annotation

ContactListScopeForOrganizationUsers Enum


Enum NameEvent TypeDescription
ALLallShow all the contacts
ORGANIZATIONorganizationShow organization contacts.
ORGANIZATION_USER_GROUPorganizationUserGroupShow organization user groups.
DOCUMENTdocumentShow document contacts.

CursorUser


PropertyTypeRequiredDescription
userIdstringYesUnique user identifier that you use to identify your user.
namestringNoYour user’s full name. Default: Random avatar name.
emailstringNoYour user’s email address.
photoUrlstringNoYour user’s display picture URL. Default: Random avatar image.
commentstringNoShort comment that user can add to their live cursor.
onlineStatusstringYesUser’s online status (active, inactive, offline). Auto generated.
colorstringNoA random color assigned to the user for the session, used on avatar border/live cursor.
timestampanyYesServer Timestamp.
typestringNoUser type.
locationIdnumber | nullNoUnique location id from provided location.
locationLocation | nullNoLocation to identify user on sub document.
positionCursorPosition | nullNoUser’s cursor position on their screen.
isReadOnlybooleanNoIndicates if user is readonly.
isAnonymousbooleanNoIndicates if user is anonymous and can only view comments.

FlockOptions


PropertyTypeRequiredDescription
useHistoryAPIbooleanYesIndicates whether the application should use the HTML5 History API for navigation
onNavigate(url: PageInfo) => voidNoA callback function that is called when navigation occurs. It takes a PageInfo object as its argument, which contains details about the new page
disableDefaultNavigationbooleanYesIf true, the application’s default navigation handling is disabled, perhaps to be managed manually or by another system
darkModebooleanYesA flag indicating whether the application should display in dark mode, a display preference that may be more comfortable for users in low-light conditions

Version


PropertyTypeRequiredDescription
idstringYesUnique identifier for the version
namestringYesName of the version

displayHeadlineMessageTemplateData


PropertyTypeRequiredDescription
actionUserUserNoThe user who performed the action
recipientUserUserNoThe user receiving the notification
actionMessagestringNoThe message describing the action
projectstringNoThe project related to the notification
[key: string]anyNoAny additional custom properties

PageInfo


PropertyTypeRequiredDescription
urlstringNoURL of the webpage
pathstringNoPath of the webpage excluding base url
baseUrlstringNoBase URL (domain) of a webpage
titlestringNoTitle of the webpage
commentUrlstringNoReference url of a comment annotation
recorderUrlstringNoReference url of a recorder annotation
screenWidthnumberNoUser’s screen width. Auto generated.

getThumbnailTag Method

The getThumbnailTag method takes an optional url parameter and returns an HTML string. It creates an anchor tag linking to the videoPlayerUrl and embeds an image tag using either the provided url, thumbnailWithPlayIconUrl, or thumbnailUrl (in that order of preference).

RewriterAnnotation


PropertyTypeRequiredDescription
annotationIdStringYesUnique identifier for the rewriter annotation, automatically generated.
fromUserYesThe user who created this rewriter annotation.
colorStringNoColor used for the rewriter annotation.
lastUpdatedAnyNoTimestamp when the rewriter annotation was last updated, automatically generated.
documentParamsIdNumber | nullNoUnique document params ID, deprecated, use locationId instead.
documentParamsLocation | nullNoDocument params to identify user on sub document, deprecated, use location instead.
locationIdNumber | nullNoUnique location ID generated from provided location.
locationLocation | nullNoSet location to identify user on sub document.
typeStringNoType of annotation.
rewriterTypeStringYesType of rewriter for the annotation, either ‘generic’ or ‘copywriter’.
targetTextRangeTargetTextRange | nullNoSelected text range of rewriter annotation.
annotationIndexNumberNoIndex of the current annotation in the list of annotations.
pageInfoPageInfoNoInformation about the page where the annotation is made.
selectedRewriterOptionStringNoSelected rewriter option used in the annotation.

SyncVideoPlayer


PropertyTypeRequiredDescription
playerIdStringNoThe identifier for the video player instance.
srcStringNoThe source URL of the video.
sourcesString[]NoAn array of source URLs for the video.
lastUpdatedNumberNoThe timestamp of when the player was last updated.
lastUpdatedByUserNoThe user who last updated the player.
lastUpdatedEventStringNoThe name of the event that triggered the last update.
playerStateSyncVideoPlayerStateYesThe state object of the video player.

SyncVideoPlayerState


PropertyTypeRequiredDescription
playingBooleanNoIndicates if the video is currently playing.
currentTimeNumberNoThe current playback time of the video.
mutedBooleanNoIndicates if the video is muted.
volumeNumberNoThe volume level of the video.
speedNumberNoThe playback rate of the video.

Toast


PropertyTypeRequiredDefault ValueDescription
idNumberNoNoneA unique identifier for the toast notification.
messageStringYesNoneThe message content displayed in the toast notification.
type’success’ | ‘error’YesNoneThe type of toast notification, indicating success or error.
durationNumberNo3000The length of time the toast notification is displayed, in milliseconds.

Transcription


PropertyTypeRequiredDescription
fromUserYesThe user who created the transcription.
lastUpdatedNumberNoTimestamp of when the transcription was last updated.
transcriptedTextStringNoThe text that has been transcribed.

User


PropertyTypeRequiredDescription
userIdstringYesUnique user identifier used to identify your user.
namestringNoThe full name of your user. Defaults to a random avatar name if not provided.
photoUrlstringNoThe display picture URL of your user. Defaults to a random avatar image if not provided.
emailstringNoRequired for sending email or Slack notifications to users about comments and mentions.
planstringNoThe product plan the user is on.
organizationIdstringYesorganizationId to which the user belongs.
colorstringNoA color assigned to the user for the current session, used for avatar border, live cursor, selection etc.
textColorstringNoUsed in the text color of the user’s intial when photoUrl is not present.
typestringNoThe type of user.
isReadOnlybooleanNoIndicates if the user has read-only access.
isAnonymousbooleanNoIndicates if the user is anonymous and can only view comments.
isGuestbooleanNoIndicates if the user is a guest.
isAdminbooleanNoUse this to set the user as an admin. You also need to ensure that the jwt token you generate also has this property set to true.
groupIdstringNo[DEPRECATED] A domain name or identifier used to cluster a group of users who work together.
clientGroupIdstringNo[DEPRECATED] The original groupId provided by the user.
initialstringNoFirst letter of the user’s first name.

UserOptions


PropertyTypeRequiredDescription
replaceContactsbooleanNoIf set to true, it will replace the user’s personal and group contacts with the ones provided.
authTokenstringNoThe authentication token of the user.

UserContactSelectedPayload


PropertyTypeRequiredDescription
contactUserContactYesSelected user contact details.
isOrganizationContactbooleanYesIs user part of organization contact.
isDocumentContactbooleanYesIs user part of document contact.
documentAccessTypestringYesDocument access type.

UserContactUs


PropertyTypeRequiredDescription
idstringNoUnique identifier of the feedback.
apiKeystring | nullNoAPI key of the client.
emailIdstringNoEmail address of the feedback provider.
messagestringNoContent of the user’s feedback message.
fromUser | nullNoUser who submitted the feedback.
lastUpdatedanyNoTimestamp of when the feedback was last updated.
metadataDocumentMetadata | nullNoMetadata associated with the document.
pageInfoPageInfoNoInformation about the user’s current page.

UserFeedback


PropertyTypeRequiredDescription
idstringNoUnique identifier of the feedback.
apiKeystring | nullNoAPI key of the client.
emailIdstringNoEmail address of the feedback provider.
messagestringNoContent of the user’s feedback message.
fromUser | nullNoUser who submitted the feedback.
lastUpdatedanyNoTimestamp of when the feedback was last updated.
metadataDocumentMetadata | nullNoMetadata associated with the document.
pageInfoPageInfoNoInformation about the user’s current page.

UnreadCommentsCount


PropertyTypeRequiredDescription
countnumberYesThe number of unread comments or threads.

UserGroup


PropertyTypeRequiredDescription
groupIdstringYesUnique identifier for the user group
groupNamestringYesDisplay name of the user group
usersUser[]NoArray of users that belong to this group

VeltResetButtonStateConfig


PropertyTypeRequiredDescription
idstringNoThe ID of the button to reset. If not provided, resets all buttons
groupstringNoThe group ID of buttons to reset. If not provided, resets buttons in all groups