Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | Unique identifier for the comment pin annotation. Auto generated |
comments | Comment[] | Yes | The list of all comments part of this annotation |
commentCategories | CustomCategory[] | Yes | The list of categories that this comment pin annotation belongs to |
from | User | Yes | The user who created this comment pin annotation |
color | string | No | Color used for the comment pin annotation |
resolved | boolean | No | Whether the comment annotation is marked resolved. Deprecated |
inProgress | boolean | No | Whether the comment annotation is marked as in progress. Deprecated |
lastUpdated | any | No | Timestamp when the comment annotation was last updated. Auto generated |
createdAt | any | No | Timestamp when the comment annotation was created. Auto generated |
position | CursorPosition | null | No | Cursor position relative to the comment annotation |
locationId | number | null | No | Unique location id generated from provided location |
location | Location | null | No | Set location to identify user on sub document |
type | string | No | Type of the comment annotation |
selectAllContent | boolean | No | If true, sets text comment annotation on all the text content |
approved | boolean | No | Whether the comment annotation is approved |
status | CustomStatus | Yes | Status of the comment annotation. Default: CommentAnnotationStatusMap.OPEN |
annotationIndex | number | No | Index of current annotation in the list |
pageInfo | PageInfo | No | Page information related to the comment annotation |
assignedTo | User | No | User to whom the comment annotation is assigned |
priority | CustomPriority | No | Priority level of the comment annotation |
ghostComment | GhostComment | null | No | Placeholder for a non-existing comment |
context | any | No | Custom context data provided by the user |
resolvedByUserId | string | No | ID of the user who resolved the comment |
subscribedUsers | CommentAnnotationSubscribedUsers | No | Users who explicitly subscribe to the comment |
unsubscribedUsers | CommentAnnotationUnsubscribedUsers | No | Users who explicitly unsubscribe to the comment |
multiThreadAnnotationId | string | No | ID of the multithread annotation group it belongs to, if created in multithread mode |
isDraft | boolean | No | Indicates if the comment annotation is in draft state |
customList | CustomAnnotationDropdownItem[] | No | Custom list of items for the comment annotation |
targetElementId | string | No | ID of the target element for the comment annotation if available |
Enum Name | Event Type | Description |
---|---|---|
ADD_COMMENT_ANNOTATION | addCommentAnnotation | Add a new comment annotation |
DELETE_COMMENT_ANNOTATION | deleteCommentAnnotation | Delete a comment annotation |
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 |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
Property | Type | Required | Description |
---|---|---|---|
userIdHash | string | Yes | The user ID of the subscribed user |
user | User | Yes | The user object of the subscribed user |
type | 'manual' | 'auto' | Yes | Manual: 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 |
Property | Type | Required | Description |
---|---|---|---|
userIdHash | string | Yes | The user ID of the unsubscribed user |
user | User | Yes | The user object of the unsubscribed user |
type | 'manual' | 'auto' | Yes | Manual: 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 |
Property | Type | Required | Description |
---|---|---|---|
annotation | CommentAnnotation | Yes | Comment annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
documentIds | string[] | Yes | Array of document IDs to query |
locationIds | string[] | No | Array of location IDs to filter by |
statusIds | string[] | No | Array of status IDs to filter by |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, CommentAnnotationsCount> | null | Yes | Map of document IDs to their comment counts. Null while loading |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, CommentAnnotation[]> | null | Yes | Map of document IDs to their annotations. Null while loading |
Property | Type | Required | Description |
---|---|---|---|
createdAfter | number | No | Filter annotations created after this timestamp |
createdBefore | number | No | Filter annotations created before this timestamp |
updatedAfter | number | No | Filter annotations updated after this timestamp |
updatedBefore | number | No | Filter annotations updated before this timestamp |
statusIds | string[] | No | Filter annotations by status IDs |
order | 'asc' | 'desc' | No | Sort order for annotations |
pageToken | string | No | Token for fetching next page of results |
allDocuments | boolean | No | Whether to fetch annotations from all documents |
pageSize | number | No | Number of results per page |
organizationId | string | No | Organization ID to fetch annotations from |
locationId | string | No | Location ID to filter annotations by |
documentIds | string[] | No | Array of specific document IDs to fetch from |
folderId | string | No | Folder ID to fetch annotations from |
resolvedBy | string | No | Filter comments by user who resolved the comment |
userIds | string[] | No | Filter comments by comment annotation author |
mentionedUserIds | string[] | No | Filter comments where provided users are tagged in the comment |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, CommentAnnotation[]> | null | Yes | Map of document IDs to their annotations. Null while loading |
nextPageToken | string | Yes | Token for fetching next page of results |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | Yes | Organization ID to fetch comments from |
commentAnnotationIds | string[] | No | Array of comment annotation IDs to fetch comments from |
documentIds | string[] | No | Array of document IDs to fetch comments from |
folderId | string | No | Folder ID to fetch comments from |
allDocuments | boolean | No | Whether to fetch comments from all documents within the given folder |
Property | Type | Required | Description |
---|---|---|---|
commentAnnotation | { [key: string]: PartialCommentAnnotation } | Yes | Map of comment annotation data to save |
metadata | BaseMetadata | No | Additional metadata for the request. eg: apikey, organizationId, documentId, etc. |
event | ResolverActions | No | Event name that caused the save request |
commentId | string | No | ID of the comment to save |
Property | Type | Required | Description |
---|---|---|---|
commentAnnotationId | string | Yes | ID of the comment annotation to delete |
metadata | BaseMetadata | No | Additional metadata for the request. eg: apikey, organizationId, documentId, etc. |
event | ResolverActions | No | Event name that caused the delete request |
Property | Type | Required | Description |
---|---|---|---|
type | 'multi' | 'single' | Yes | The type of the custom annotation dropdown |
placeholder | string | Yes | The placeholder text for the dropdown. Defaults to ‘Select’ |
data | CustomAnnotationDropdownItem[] | Yes | An array of dropdown items |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | The unique identifier for the dropdown item |
label | string | Yes | The display text for the dropdown item |
Property | Type | Required | Description |
---|---|---|---|
documentIds | string[] | Yes | List of document IDs to query |
locationIds | string[] | Yes | List of location IDs to filter |
statusIds | string[] | Yes | List of status IDs to filter |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, CommentAnnotation[]> | Yes | Map of document IDs to their comment annotations |
Property | Type | Required | Description |
---|---|---|---|
unread | number | Yes | Number of unread comments |
total | number | Yes | Total number of comments |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, CommentAnnotationsCount> | Yes | Map of document IDs to their comment counts |
Enum Name | Event Type | Description |
---|---|---|
ADD_COMMENT | addComment | Add a new comment |
UPDATE_COMMENT | updateComment | Update an existing comment |
DELETE_COMMENT | deleteComment | Delete a comment |
Property | Type | Required | Description |
---|---|---|---|
commentId | number | Yes | Unique identifier for the comment pin annotation. Auto generated. |
type | 'text' | 'voice' | Yes | This determines the comment content type. Default is ‘text’. |
commentText | string | Yes | The actual text content of the comment. |
commentHtml | string | No | Same comment text but formatted in HTML. |
replaceContentHtml | string | No | HTML content to replace the comment text when user accepts the comment. |
replaceContentText | string | No | Text content to replace the comment text when user accepts the comment. |
commentVoiceUrl | string | No | URL of the voice recording for the comment, if available. |
from | User | Yes | The user who created this comment. |
to | User[] | No | List of users that were @mentioned in this comment. |
lastUpdated | Date | No | Timestamp of when this comment was last updated. Auto generated. |
editedAt | any | No | Timestamp of when this comment was edited. Auto generated. |
createdAt | any | No | Timestamp of when this comment was created. Auto generated. |
isEdited | boolean | No | Whether the comment has been edited. Auto generated. |
status | 'added' | 'updated' | Yes | Status of the comment indicating whether it was newly added or updated. |
attachments | Attachment[] | Yes | List of attachments associated with the comment. |
recorders | RecordedData[] | Yes | List of recorded data associated with the comment. |
reactionAnnotationIds | string[] | Yes | List of annotation IDs for reactions to the comment. |
taggedUserContacts | AutocompleteUserContactReplaceData[] | Yes | List of users that were @mentioned in this comment with UI metadata. |
customList | AutocompleteReplaceData[] | Yes | List of custom list items added to the comment. |
isDraft | boolean | Yes | Whether the comment is in draft state. |
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 |
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 |
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 |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
comment | Comment | Yes | Comment object |
assignedTo | User | No | Assigned user |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
comment | Comment | Yes | Comment object |
merge | boolean | No | Merge comments |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
skipDeleteThreadConfirmation | boolean | No | Skip delete confirmation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Enum Name | Event Type | Description |
---|---|---|
ASSIGN_USER | assignUser | Assign a user to a comment |
SUBSCRIBE_COMMENT_ANNOTATION | subscribeCommentAnnotation | Subscribe to a comment annotation |
UNSUBSCRIBE_COMMENT_ANNOTATION | unsubscribeCommentAnnotation | Unsubscribe from a comment annotation |
AUTOCOMPLETE_SEARCH | autocompleteSearch | When user starts searching for a contact in the @mentions dropdown |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
assignedTo | UserContact | Yes | User to assign |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
organizationUsers | User[] | No | List of users in the organization |
folderUsers | User[] | No | List of users added to the folder |
documentUsers | User[] | No | List of users added to the document |
userGroups | UserGroup[] | No | List of user groups in the organization |
updatedContactList | User[] | No | List of contacts updated via updateContactList API |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier |
name | string | Yes | Name of the item |
description | string | No | Optional description |
icon | object | No | Optional icon information |
icon.url | string | No | URL of the icon |
link | string | No | Link associated with item |
Property | Type | Required | Description |
---|---|---|---|
text | string | Yes | The text displayed in the comment that represents the tagged user |
userId | string | Yes | The user ID of the tagged user |
contact | User | No | The user object of the tagged user |
Property | Type | Required | Description |
---|---|---|---|
text | string | Yes | The text displayed in the comment that represents the custom item |
custom | AutocompleteItem | Yes | The custom item object associated with this text |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the autocomplete item |
name | string | Yes | Name or label of the autocomplete item |
description | string | No | Additional description of the autocomplete item |
icon | { url?: string } | No | Icon associated with the autocomplete item |
link | string | No | Optional link associated with the autocomplete item |
Property | Type | Required | Description |
---|---|---|---|
hotkey | string | Yes | The hotkey or trigger for this autocomplete data |
description | string | No | Optional description of the autocomplete data |
type | 'custom' | 'contact' | 'group' | Yes | The type of autocomplete data. Default is ‘custom’ |
data | AutocompleteItem[] | Yes | An array of AutocompleteItem objects |
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 |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
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 |
Enum Name | Event Type | Description |
---|---|---|
AUTOCOMPLETE_SEARCH | autocompleteSearch | When user starts searching for a list item in the custom list dropdown |
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 |
Enum Name | Event Type | Description |
---|---|---|
ADD_ATTACHMENT | addAttachment | Add an attachment to a comment |
DELETE_ATTACHMENT | deleteAttachment | Delete an attachment from a comment |
Property | Type | Required | Description |
---|---|---|---|
attachmentId | number | Yes | Unique identifier for the attachment. Auto-generated |
name | string | No | File name of the attachment |
size | number | No | File size of the attachment |
type | string | No | File type of the attachment |
url | string | No | Download URL of the attachment |
thumbnail | string | No | Thumbnail image in base64 format |
thumbnailWithPlayIconUrl | string | No | URL of the thumbnail with a play icon overlay |
metadata | any | No | Additional metadata of the attachment |
mimeType | any | No | MIME type of the attachment |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
files | File[] | Yes | Array of files |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
attachmentId | number | Yes | ID of the attachment |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
valid | boolean | Yes | Validity status |
file | File | No | File object |
maxAllowedSize | number | Yes | Max allowed size |
error | string | No | Error message |
attachment | Attachment | No | Attachment object |
Property | Type | Required | Description |
---|---|---|---|
attachmentId | number | Yes | ID of the attachment |
metadata | AttachmentResolverMetadata | No | Additional metadata for the request. eg: apikey, organizationId, documentId, etc. |
event | ResolverActions | No | Event that triggered the delete |
Property | Type | Required | Description |
---|---|---|---|
attachment | ResolverAttachment | Yes | Attachment object to save |
metadata | AttachmentResolverMetadata | No | Additional metadata for the request. eg: apikey, organizationId, documentId, etc. |
event | ResolverActions | No | Event that triggered the save |
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 |
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 |
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 |
Enum Name | Event Type | Description |
---|---|---|
ADD_REACTION | addReaction | Add a reaction to a comment |
DELETE_REACTION | deleteReaction | Delete a reaction from a comment |
TOGGLE_REACTION | toggleReaction | Toggle a reaction on a comment |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
url | string | No | URL of the reaction image |
emoji | string | No | Emoji character |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | Yes | ID of the organization to fetch reactions from |
reactionAnnotationIds | string[] | No | Array of reaction annotation IDs to fetch reactions from |
documentIds | string[] | No | Array of document IDs to fetch reactions from |
folderId | string | No | ID of the folder to fetch reactions from |
allDocuments | boolean | No | Whether to get reactions from all documents within the given folder |
Property | Type | Required | Description |
---|---|---|---|
reactionAnnotation | { [key: string]: PartialReactionAnnotation } | Yes | Map of reaction annotation id to reaction annotation data |
metadata | BaseMetadata | No | Additional metadata for the request. eg: apikey, organizationId, documentId, etc. |
event | ResolverActions | No | Event name that caused the save request |
Property | Type | Required | Description |
---|---|---|---|
reactionAnnotationId | string | Yes | ID of the reaction annotation |
metadata | BaseMetadata | No | Additional metadata for the request. eg: apikey, organizationId, documentId, etc. |
event | ResolverActions | No | Event name that caused the delete request |
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 |
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 |
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 |
Enum Name | Event Type | Description |
---|---|---|
UPDATE_STATUS | updateStatus | Update the status of a comment |
RESOLVE_COMMENT | resolveComment | Resolve a comment |
UPDATE_PRIORITY | updatePriority | Update the priority of a comment |
APPROVE_COMMENT_ANNOTATION | approveCommentAnnotation | Approve a comment annotation |
ACCEPT_COMMENT_ANNOTATION | acceptCommentAnnotation | Accept a comment annotation |
REJECT_COMMENT_ANNOTATION | rejectCommentAnnotation | Reject a comment annotation |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
status | CustomStatus | Yes | Status value |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
priority | CustomPriority | No | Priority object |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom priority |
color | string | Yes | Color associated with the custom priority |
name | string | Yes | Name or label of the custom priority |
lightColor | string | No | Light color variant for the custom priority |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom status |
color | string | Yes | Text and comment pin color associated with the custom status |
name | string | Yes | Name or label of the custom status |
type | StatusType | Yes | Type of the status (default , ongoing , or terminal ) |
lightColor | string | No | Background color on the status indicator for the custom status |
iconUrl | string | No | URL to an icon image for the custom status |
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 |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
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 |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
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 |
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 |
Enum Name | Event Type | Description |
---|---|---|
DELETE_RECORDING | deleteRecording | Delete a recording from a comment |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
recorderId | string | Yes | ID of the recorder |
options | RequestOptions | No | Request options |
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 |
Enum Name | Event Type | Description |
---|---|---|
COPY_LINK | copyLink | Copy a deep link to a comment |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
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 |
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 |
Enum Name | Event Type | Description |
---|---|---|
UPDATE_ACCESS | updateAccess | Update access settings for a comment |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the annotation |
accessMode | CommentAccessMode | Yes | Access mode |
options | RequestOptions | No | Request options |
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 |
Enum Name | Event Type | Description |
---|---|---|
COMPOSER_CLICKED | composerClicked | Triggered when comment composer is clicked |
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 |
Enum Name | Event Type | Description |
---|---|---|
COMMENT_SIDEBAR_DATA_INIT | commentSidebarDataInit | Triggered when comment sidebar data is first loaded |
COMMENT_SIDEBAR_DATA_UPDATE | commentSidebarDataUpdate | Triggered when comment sidebar data is updated |
Property | Type | Required | Description |
---|---|---|---|
color | string | Yes | Primary color for the status. |
id | string | Yes | Unique identifier for the status. |
lightColor | string | Yes | Light variant of the status color. |
name | string | Yes | Display name of the status. |
svg | string | Yes | SVG icon for the status. |
type | string | No | Optional type classification for the status. |
Property | Type | Required | Description |
---|---|---|---|
color | string | Yes | Primary color for the priority. |
id | string | Yes | Unique identifier for the priority. |
lightColor | string | Yes | Light variant of the priority color. |
name | string | Yes | Display name of the priority. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom filter |
color | string | Yes | Color associated with the custom filter |
name | string | Yes | Name or label of the custom filter |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom category |
color | string | Yes | Color associated with the custom category |
name | string | Yes | Name or label of the custom category |
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 |
customFilters | CustomFilters | No | Custom filters applied in the Comment Sidebar. Only available when custom sidebar filters are used. |
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 |
customFilters | CustomFilters | No | Custom filters applied in the Comment Sidebar. Only available when custom sidebar filters are used. |
Property | Type | Required | Description |
---|---|---|---|
location | FilterTypeConfig | No | Configuration for the location filter type. |
document | FilterTypeConfig | No | Configuration for the document filter type. Only use it if you are using multiple documents or folders |
people | FilterTypeConfig | No | Configuration for the author filter type. |
tagged | FilterTypeConfig | No | Configuration for the tagged/mentioned filter type. |
assigned | FilterTypeConfig | No | Configuration for the assigned filter type. |
involved | FilterTypeConfig | No | Configuration for the involved filter type (author, mentioned, assigned). |
priority | FilterTypeConfig | No | Configuration for the priority filter type. |
category | FilterTypeConfig | No | Configuration for the category filter type. |
commentType | FilterTypeConfig | No | Configuration for the comment type filter. |
version | FilterTypeConfig | No | Configuration for the version filter type. |
status | FilterTypeConfig | No | Configuration for the status filter type. |
[key: string] | FilterTypeConfig | undefined | No | Custom filter type configurations. |
Property | Type | Required | Description |
---|---|---|---|
name | string | No | The name of the filter type |
enable | boolean | No | Enables or disables the filter type |
multiSelection | boolean | No | Allows multiple selections if set to true |
enableGrouping | boolean | No | Enables grouping within the filter type if set to true |
placeholder | string | No | The placeholder text for the filter type. Used when filterOptionLayout is set to dropdown |
id | string | No | The unique identifier for the filter type |
type | 'custom' | 'system' | No | The type of filter - custom or system |
options | FilterOption[] | No | Array of filter options available for this filter type |
Property | Type | Required | Description |
---|---|---|---|
enable | boolean | No | Enables or disables grouping |
name | string | No | The name of the group |
[key: string] | { id?: string, name?: string }[] | string[] | undefined | No | Custom filter configurations |
Property | Type | Required | Description |
---|---|---|---|
location | {id: string}[] | No | Filter by location Ids |
document | {id: string}[] | No | Filter by document Ids |
people | {userId: string}[] | No | Filter by author of comment annotation |
tagged | {userId: string}[] | No | Filter by users who were tagged/mentioned in the comment |
assigned | {userId: string}[] | No | Filter by users who were assigned to the comment annotation |
involved | {userId: string}[] | No | Filter by users who are involved in the comment annotation (author, mentioned, assigned) |
priority | string[] | No | Filter by priority ids |
status | string[] | No | Filter by status ids |
category | string[] | No | Filter by category ids |
version | {id: string}[] | No | Filter by version Ids |
Property | Type | Required | Description |
---|---|---|---|
groupId | string | No | ID of the group. Defaults to ‘others’ |
groupName | string | No | Name of the group. Defaults to ‘Others’ |
isExpanded | boolean | No | Whether the group is expanded. Defaults to true |
annotations | CommentAnnotation[] | Yes | List of CommentAnnotations in the group |
Property | Type | Required | Description |
---|---|---|---|
grouping | boolean | No | Whether to group the data. Defaults to true |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the filter option |
name | string | Yes | Display name for the filter option |
selected | boolean | Yes | Whether the filter option is currently selected |
Property | Type | Required | Description |
---|---|---|---|
[key: string] | CustomFilterOption[] | No | Custom filter configurations mapped by filter key |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the filter option |
name | string | Yes | Display name for the filter option |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom filter. |
color | string | Yes | Color associated with the custom filter. |
name | string | Yes | Name or label of the custom filter. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom priority. |
color | string | Yes | Color associated with the custom priority. |
name | string | Yes | Name or label of the custom priority. |
lightColor | string | No | Light color variant for the custom priority. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom status. |
color | string | Yes | Color associated with the custom status. |
name | string | Yes | Name or label of the custom status. |
type | StatusType | Yes | Type of the status (default , ongoing , or terminal ). |
lightColor | string | No | Light color for the custom status. |
iconUrl | string | No | URL to an icon image for the custom status. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the custom category. |
color | string | Yes | Color associated with the custom category. |
name | string | Yes | Name or label of the custom category. |
Enum Name | Event Type | Description |
---|---|---|
TRANSCRIPTION_DONE | transcriptionDone | Triggered when a transcription is generated and ready |
RECORDING_DONE | recordingDone | Triggered when a recording is completed |
RECORDING_DELETE | deleteRecording | Triggered when a recording is deleted |
RECORDING_EDIT_DONE | recordingEditDone | Triggered when a recording is edited and saved |
RECORDING_SAVE_INITIATED | recordingSaveInitiated | Triggered when a recording saved is initiated |
ERROR | error | Triggered when an error occurs during recording operations |
Property | Type | Required | Description |
---|---|---|---|
recorderIds | string[] | Yes | Array of recorder IDs to query |
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 latest version of the recording |
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 latest version of the recording |
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 latest version of the recording |
Property | Type | Required | Description |
---|---|---|---|
safari | RecorderQualityConstraintsOptions | No | Constraints specific to the Safari browser. |
other | RecorderQualityConstraintsOptions | No | Constraints for other browsers (e.g., Chrome, Firefox, Edge). |
Property | Type | Required | Description |
---|---|---|---|
safari | MediaRecorderOptions | No | Encoding options specific to the Safari browser. |
other | MediaRecorderOptions | No | Encoding options for other browsers (e.g., Chrome, Firefox, Edge). |
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 |
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 |
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 |
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’. |
Property | Type | Required | Description |
---|---|---|---|
type | 'audio' | 'video' | 'screen' | Yes | The type of recording that started. |
Property | Type | Required | Description |
---|---|---|---|
type | 'audio' | 'video' | 'screen' | Yes | The type of recording that was paused. |
Property | Type | Required | Description |
---|---|---|---|
type | 'audio' | 'video' | 'screen' | Yes | The type of recording that was resumed. |
Property | Type | Required | Description |
---|---|---|---|
type | 'audio' | 'video' | 'screen' | Yes | The type of recording that was cancelled. |
Property | Type | Required | Description |
---|---|---|---|
type | 'audio' | 'video' | 'screen' | Yes | The type of recording that was stopped. |
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 |
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. |
Property | Type | Required | Description |
---|---|---|---|
type | { audio?: boolean, video?: boolean, screen?: boolean } | Yes | Types of media to be recorded |
recorderOptions | MediaRecorderOptions | No | Options for the media recorder |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Annotation ID of recorder annotation |
tag | string | Yes | Recorder player tag containing recorder annotation id which can be added anywhere on the DOM |
type | string | Yes | Type of recorded data. Possible values are ‘audio’, ‘video’, and ‘screen’ |
thumbnailUrl | string | No | URL of the thumbnail image for the recorded data |
thumbnailWithPlayIconUrl | string | No | URL of the thumbnail image with a play icon overlay |
videoUrl | string | No | URL of the recorded video |
audioUrl | string | No | URL of the recorded audio |
videoPlayerUrl | string | No | URL of the hosted website to open video in a new tab |
getThumbnailTag | function | Yes | A method that returns an HTML string for displaying the thumbnail with a link to the video player |
Property | Type | Required | Description | |
---|---|---|---|---|
annotationId | String | Yes | Unique identifier for the recorder annotation, automatically generated. | |
from | User | Yes | The user who created the recorder annotation. | |
color | String | No | Color used for the annotation. | |
lastUpdated | Any | No | Timestamp of the last update, automatically generated. | |
locationId | Number | No | Unique location ID from provided location. | |
location | Location | No | Location to identify user on sub document. | |
type | String | No | Type of annotation. | |
recordingType | String | Yes | Type of recording for the annotation. | |
mode | String | Yes | Mode of the recorder annotation, ‘floating’ or ‘thread’. | |
approved | Boolean | No | Indicates if the annotation is approved. | |
attachment | Attachment | No | Attachment for recorded media. Deprecated. | |
attachments | Attachment[] | Yes | List of attachments for the annotation. | |
annotationIndex | Number | No | Index of the annotation in a list. | |
pageInfo | PageInfo | No | Information about the page where the annotation is made. | |
recordedTime | Object | No | Recorded time details. | |
transcription | Transcription | No | Transcription of the recorded media. |
Property | Type | Required | Description |
---|---|---|---|
startTime | String | Yes | Start time of the transcription segment |
endTime | String | Yes | End time of the transcription segment |
startTimeInSeconds | Number | Yes | Start time of the segment in seconds |
endTimeInSeconds | Number | Yes | End time of the segment in seconds |
text | String | Yes | Transcribed text content of the segment |
Property | Type | Required | Description |
---|---|---|---|
transcriptSegments | RecorderDataTranscriptSegment[] | No | Array of transcription segments |
vttFileUrl | String | No | URL to the VTT format transcription file |
contentSummary | String | No | Summary of the transcribed content |
Property | Type | Required | Description |
---|---|---|---|
version | number | No | Version of the asset. |
url | string | Yes | URL to the recorded media |
mimeType | string | No | MIME type of the recorded media |
fileName | string | No | Name of the recorded file |
fileSizeInBytes | number | No | File size in bytes |
fileFormat | RecorderFileFormat | No | The format/extension of the file. Example: ‘mp3’, ‘mp4’, ‘webm’ |
thumbnailUrl | string | No | URL to the thumbnail image |
transcription | RecorderDataTranscription | No | Transcription data for the recording |
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 latest version of the recording |
Property | Type | Required | Description |
---|---|---|---|
audio | Object | No | Configuration for audio preview |
audio.enabled | boolean | No | Whether audio preview is enabled |
audio.deviceId | string | No | Device ID for audio input |
video | Object | No | Configuration for video preview |
video.enabled | boolean | No | Whether video preview is enabled |
video.deviceId | string | No | Device ID for video input |
screen | Object | No | Configuration for screen preview |
screen.enabled | boolean | No | Whether screen preview is enabled |
screen.stream | MediaStream | No | MediaStream for screen sharing |
Property | Type | Required | Description |
---|---|---|---|
audioBitsPerSecond | number | No | Controls the audio encoding quality by setting the number of bits used per second for audio. |
videoBitsPerSecond | number | No | Controls the video encoding quality by setting the number of bits used per second for video. |
Property | Type | Required | Description |
---|---|---|---|
video | MediaTrackConstraints | No | Specifies the constraints for the video track. |
audio | MediaTrackConstraints | No | Specifies the constraints for the audio track. |
Property | Type | Required | Description |
---|---|---|---|
aspectRatio | ConstrainDouble | No | Controls the width-to-height ratio of the captured video stream. |
frameRate | ConstrainDouble | No | Determines the number of frames per second for the video stream. |
height | ConstrainULong | No | Sets the vertical resolution (in pixels) of the video stream. |
width | ConstrainULong | No | Sets the horizontal resolution (in pixels) of the video stream. |
autoGainControl | ConstrainBoolean | No | Enables/disables automatic volume adjustment for audio input. |
echoCancellation | ConstrainBoolean | No | Enables/disables the removal of audio echo effects. |
noiseSuppression | ConstrainBoolean | No | Enables/disables the filtering of background noise from audio. |
sampleRate | ConstrainULong | No | Controls the number of audio samples taken per second. |
Property | Type | Required | Description |
---|---|---|---|
min | number | No | The minimum acceptable value. |
max | number | No | The maximum acceptable value. |
ideal | number | No | The preferred value that the browser will try to match if possible. |
exact | number | No | A mandatory value that must be matched exactly or the request fails. |
Property | Type | Required | Description |
---|---|---|---|
min | number | No | The minimum acceptable value. |
max | number | No | The maximum acceptable value. |
ideal | number | No | The preferred value that the browser will try to match if possible. |
exact | number | No | A mandatory value that must be matched exactly or the request fails. |
Property | Type | Required | Description |
---|---|---|---|
ideal | boolean | No | The preferred value that the browser will try to match if possible. |
exact | boolean | No | A mandatory value that must be matched exactly or the request fails. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Notification ID |
notificationSource | string | Yes | Notification source. e.g., ‘comment’, ‘custom’, etc. |
actionType | string | No | Action that triggered the notification. e.g., ‘added’ |
isUnread | boolean | No | Whether the notification is unread for the user |
actionUser | User | No | The user who triggered the action |
timestamp | number | No | Timestamp of the notification |
displayHeadlineMessage | string | No | The headline message of the notification |
displayBodyMessage | string | No | The body message of the notification |
displayHeadlineMessageTemplate | string | No | The template of the headline message |
displayHeadlineMessageTemplateData | object | No | The data used to fill the headline message template |
forYou | boolean | No | Whether the notification is for the current logged-in user |
targetAnnotationId | string | No | ID of the annotation that triggered the notification |
notificationSourceData | any | No | The data of the notification source. e.g., CommentAnnotation |
metadata | NotificationMetadata | No | Metadata for the current notification. e.g., documentId |
notifyUsers | { [emailHash: string]: boolean } | No | Map of email hashes to boolean values indicating whether to notify the user |
notifyUsersByUserId | { [userIdHash: string]: boolean } | No | Map of user ID hashes to boolean values indicating whether to notify the user |
Property | Type | Required | Description |
---|---|---|---|
apiKey | string | No | Your API key |
clientOrganizationId | string | No | The organization ID that you set |
organizationId | string | No | The organization ID generated by us |
clientDocumentId | string | No | The document ID that you set |
documentId | string | No | The document ID generated by us |
locationId | number | No | The unique location ID |
location | Location | No | The location object |
documentMetadata | Object | No | Contains the complete document metadata object |
organizationMetadata | Object | No | Contains the complete organization metadata object |
Property | Type | Required | Description |
---|---|---|---|
settings | NotificationSettingsConfig | Yes | The updated notification settings configuration. |
isMutedAll | boolean | Yes | Whether all notifications are muted. |
Enum Name | Event Type | Description |
---|---|---|
SETTINGS_UPDATED | settingsUpdated | Triggered when the notification settings are updated |
Property | Type | Required | Description |
---|---|---|---|
[key: string] | NotificationSettingsItemType | No | Dynamic key-value pairs for notification settings configuration. The key represents the channel ID and the value represents the one of the NotificationSettingsItemType. |
'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.Property | Type | Required | Description |
---|---|---|---|
name | string | No | Display name for the notification channel. |
id | string | Yes | Unique channel ID for the notification channel. |
default | string | No | Default value for the notification channel. |
enable | boolean | No | Whether the notification channel is enabled. |
values | NotificationConfigValue[] | No | Array of possible values for the notification channel. |
Property | Type | Required | Description |
---|---|---|---|
id | NotificationSettingsItemType | Yes | Unique id for the configuration value. |
name | string | No | Display name for the configuration value. |
Property | Type | Required | Description |
---|---|---|---|
type | 'all' | 'forYou' | 'documents' | No | Filter for notification type: all, for you, or documents. |
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” ). |
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. |
Property | Type | Required | Description |
---|---|---|---|
editor | User | null | No | The user who is currently editing, if any |
requestEditorAccess | Object | null | No | Details about a request for editor access |
tabId | string | null | No | The identifier of the tab, if applicable |
Property | Type | Required | Description |
---|---|---|---|
user | User | Yes | The user requesting editor access |
requestedAt | any | Yes | The timestamp when the access was requested |
status | 'pending' | 'accepted' | 'rejected' | 'cancelled' | Yes | The status of the access request |
editorAccessTimeout | number | Yes | Timeout duration for the editor access |
tabId | string | null | No | The identifier of the tab related to the access request |
Property | Type | Required | Description |
---|---|---|---|
customMode | boolean | No | Enables/disables custom mode. In custom mode, input elements are not disabled for the viewer |
singleTabEditor | boolean | Yes | Enables/disables editor mode on a single tab only |
Property | Type | Required | Description |
---|---|---|---|
isEditor | boolean | No | Indicates whether the user has editor privileges |
isEditorOnCurrentTab | boolean | No | Indicates whether the user is an editor on the current tab |
Property | Type | Required | Description |
---|---|---|---|
state | 'idle' | 'inProgress' | 'completed' | Yes | The state of the Editor Access Request timer |
durationLeft | number | No | Duration left for the editor access timer to be completed. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | A unique identifier likely used for quick reference and indexing. It’s an MD5 hash of liveStateDataId |
liveStateDataId | string | Yes | A unique identifier for the state data being synced |
data | string | number | boolean | JSON | Yes | The actual data you want to synchronize across clients |
lastUpdated | any | Yes | A timestamp or similar data indicating the last time the state data was updated |
updatedBy | User | Yes | The user who last updated the state data |
tabId | string | null | No | An identifier that could be used to associate the state data with a specific tab or instance |
Property | Type | Required | Description |
---|---|---|---|
custom | { [liveStateDataId: string]: LiveStateData; } | No | Map of all unique LiveStateData set by you on the given document. |
default | Object | No | Map of all unique LiveStateData set by the default editor on the given document. |
default.singleEditor | SingleEditorLiveStateData | No | Part of default , representing single editor live state data. |
default.autoSyncState | Object | Part of default , representing auto synchronization state. | |
default.autoSyncState.current | LiveStateData | No | Part of autoSyncState , current live state data. |
default.autoSyncState.history | [liveStateDataId: string]: LiveStateData | No | Part of autoSyncState , map of historical live state data keyed by live state data ID. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the live state data |
locationName | string | Yes | Name of the location |
version | Version | Yes | Version information |
[key: string] | any | Yes | Additional dynamic properties |
Property | Type | Required | Description |
---|---|---|---|
merge | boolean | No | Whether to merge data with existing data. Default is false . |
Property | Type | Required | Description |
---|---|---|---|
ONLINE | string | Yes | Server connection is online and active. Value: ‘online’ |
OFFLINE | string | Yes | Server connection is offline. Value: ‘offline’ |
PENDING_INIT | string | Yes | Server connection initialization is pending. Value: ‘pendingInit’ |
PENDING_DATA | string | Yes | Server is waiting for data. Value: ‘pendingData’ |
Enum Name | Event Type | Description |
---|---|---|
VELT_BUTTON_CLICK | veltButtonClick | Triggered when a Velt Button is clicked |
USER_UPDATE | userUpdate | Triggered when the Velt user is updated |
DOCUMENT_INIT | documentInit | Triggered when the Velt document is initialized |
ERROR | error | Triggered when an error occurs. Currently this is only triggered for token_expired error. In future, this will be extended for other relevant errors. |
Property | Type | Required | Description |
---|---|---|---|
documentId | string | Yes | Unique document id generated from client document id |
documentName | string | No | Display name of the document |
folderId | string | No | ID of the folder containing this document |
apiKey | string | No | API key associated with the document |
organizationId | string | Yes | Organization ID that owns this document |
locations | { [locationId: number]: LocationMetadata } | No | Location metadata for this document |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | Yes | Organization ID to fetch folders from |
folderId | string | No | Parent folder ID to fetch child folders from |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, FolderMetadata> | null | Yes | Map of folder IDs to their metadata. Null while loading |
nextPageToken | string | Yes | Token for fetching next page of results |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | Yes | Organization ID to fetch documents from |
documentIds | string[] | No | Array of specific document IDs to fetch |
folderId | string | No | Folder ID to fetch documents from |
allDocuments | boolean | No | Whether to fetch all documents from folder |
Property | Type | Required | Description |
---|---|---|---|
data | Record<string, DocumentMetadata> | null | Yes | Map of document IDs to their metadata. Null while loading |
nextPageToken | string | Yes | Token for fetching next page of results. Default page size is 1000. |
DocumentInitEvent
can be of type: boolean | undefined
Property | Type | Required | Description |
---|---|---|---|
code | string | Yes | Error code |
message | string | No | Error message |
Code | Description |
---|---|
token_expired | The JWT token has expired |
UserUpdateEvent
will return data of type: User | null
null
else it will return the user object.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 |
customFilters | CustomFilters | No | Custom filters applied in the Comment Sidebar. Only available when custom sidebar filters are used and when the button is in the sidebar. |
Property | Type | Required | Description |
---|---|---|---|
urlAllowList | string[] | No | Restricts Velt features to specific pages by specifying partial URL strings. |
featureAllowList | FeatureType[] | No | Only allows the provided Velt features to run. |
userPlanAllowList | string[] | No | Restricts Velt features to specific user plans. |
userIdAllowList | string[] | No | Restricts Velt features to specific users. |
usePrefersColorScheme | boolean | No | If set to true, listens to changes on the prefers-color-scheme media query to set the global theme of Velt components. |
Property | Type | Required | Description |
---|---|---|---|
AREA | 'area' | No | Area feature for drawing areas/rectangles |
ARROW | 'arrow' | No | Arrow feature for drawing arrows |
AUDIO_HUDDLE | 'audioHuddle' | No | Audio huddle feature for voice conversations |
COMMENT | 'comment' | No | Comment feature for adding comments |
CURSOR | 'cursor' | No | Cursor feature for showing user cursors |
HUDDLE | 'huddle' | No | Huddle feature for video conversations |
LIVE_STATE_SYNC | 'liveStateSync' | No | Live state sync feature |
PRESENCE | 'presence' | No | Presence feature for showing online users |
TAG | 'tag' | No | Tag feature for adding tags |
RECORDER | 'recorder' | No | Recorder feature for recording sessions |
REWRITER | 'rewriter' | No | Rewriter feature for text rewriting |
LIVE_SELECTION | 'liveSelection' | No | Live selection feature for showing user selections |
Property | Type | Required | Description |
---|---|---|---|
organizationMetadata | OrganizationMetadata | null | No | Organization metadata |
documentMetadata | DocumentMetadata | null | No | Document metadata |
location | Location | null | No | Location information |
Property | Type | Required | Description |
---|---|---|---|
type | 'button' | 'button-toggle' | 'multi-select' | 'single-select' | No | Type of button (default: ‘button’) |
groupId | string | No | ID of the button group |
selections | VeltButtonSelectionMap | No | Map of button selections grouped by button groupIds. For buttons without a group, the groupdId will be ‘ungrouped’ |
clickedButtonId | string | No | ID of the clicked button |
Property | Type | Required | Description |
---|---|---|---|
[groupId: string] | { [buttonId: string]: boolean } | No | Map of button selections for a group |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | No | Unique identifier for the organization. |
documentIds | string[] | No | Array of document IDs to update locations for. |
locations | UpdateLocationMetadata<T>[] | No | Array of location metadata objects to update. |
Property | Type | Required | Description | |
---|---|---|---|---|
id | string | Yes | Unique identifier for the location. | |
[key: string] | `T | string` | No | Additional custom properties for the location metadata. |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | No | Unique identifier for the organization. |
folderId | string | No | Unique identifier for the folder. |
documents | UpdateDocumentMetadata<T>[] | No | Array of document metadata objects to update. |
Property | Type | Required | Description | |
---|---|---|---|---|
documentId | string | Yes | Unique identifier for the document. | |
[key: string] | `T | string` | No | Additional custom properties for the document metadata. |
Property | Type | Required | Description |
---|---|---|---|
apiKey | string | Yes | API key associated with the event. |
pageInfo | PageInfo | Yes | Information about the page where the event occurred. |
folderId | string | No | Unique identifier for the folder. |
locations | object | Yes | Object containing location data indexed by location ID. |
document | DocumentMetadata | No | Document metadata associated with the event. |
organization | OrganizationMetadata | No | Organization metadata associated with the event. |
[key: string] | any | No | Additional custom properties. |
Property | Type | Required | Description |
---|---|---|---|
documentId | string | Yes | Unique identifier for the document. |
documentName | string | No | Name of the document. |
organizationId | string | No | Unique identifier for the organization. |
folderId | string | No | Unique identifier for the folder. |
[key: string] | any | No | Additional custom properties. |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | Yes | Unique identifier for the organization. |
[key: string] | any | No | Additional custom properties. |
Property | Type | Required | Description |
---|---|---|---|
baseUrl | string | Yes | Base URL of the page. |
path | string | Yes | Path of the page. |
queryParams | string | No | Query parameters of the page URL. |
title | string | Yes | Title of the page. |
url | string | Yes | Full URL of the page. |
Property | Type | Required | Description |
---|---|---|---|
apiKey | string | Yes | API Key. Must be provided, cannot be empty or whitespace only. |
userId | string | Yes | User ID. Must be provided, cannot be empty or whitespace only. |
userProperties | UserProperties | No | Additional user information to embed in the auth token. See below for details. |
permissions | { resources: Resource[] } | No | Permissions configuration. Defines what resources the user can access and their access levels. If not provided, defaults to no resource access. |
Property | Type | Required | Description |
---|---|---|---|
isAdmin | boolean | No | Whether the user is an admin. |
name | string | No | User’s display name. If provided, cannot be empty or whitespace only. |
email | string | No | User’s email address. If provided, cannot be empty and must be a valid email format. |
[key: string] | any | No | Allows flexibility for custom user attributes. |
Property | Type | Required | Description |
---|---|---|---|
resources | Resource[] | No | Array of resources the user has permission to access. Defaults to empty array if not set. |
Property | Type | Required | Description |
---|---|---|---|
type | 'organization' | 'folder' | 'document' | Yes | Resource type. Must be one of: ‘organization’, ‘folder’, or ‘document’. Determines the scope and level of access. |
id | string | Yes | Unique identifier for the specific resource. Cannot be whitespace only. For organization: the organization ID. For folder: the folder ID. For document: the document ID. |
organizationId | string | Conditionally | Organization 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. |
expiresAt | number | No | Expiration timestamp (Unix timestamp). If provided, must be a positive integer, greater than the current time, and a valid number. Used for temporary access grants. |
Property | Type | Required | Description |
---|---|---|---|
apiKey | string | No | API key associated with the request. |
documentId | string | No | Unique identifier for the document. |
organizationId | string | No | Unique identifier for the organization. |
folderId | string | No | Unique identifier for the folder. |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the document |
metadata | DocumentMetadata | Yes | Metadata associated with the document |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | No | Organization ID for the documents |
folderId | string | No | Subscribe to all or provided documents in the given folder |
locationId | string | No | Filter and subscribe to document data for a specific location |
allDocuments | boolean | No | Subscribe to all documents in the folder. Use this when folderId is provided |
rootDocumentId | string | No | The unique identifier of the root document. Used to specify the root document when multiple documents are subscribed. |
Property | Type | Required | Description |
---|---|---|---|
folderId | string | No | Unique identifier for the folder |
parentFolderId | string | No | ID of the parent folder |
folderName | string | No | Display name of the folder |
createdAt | number | No | Timestamp when folder was created |
lastUpdated | number | No | Timestamp when folder was last updated |
apiKey | string | No | API key associated with the folder |
organizationId | string | No | Organization ID that the folder belongs to |
Property | Type | Required | Description |
---|---|---|---|
type | ’link’ | ‘styles’ | Yes | The type of custom CSS, either a link to a CSS file or inline styles. |
value | string | Yes | The value of the custom CSS, either a URL or CSS styles. |
Property | Type | Required | Description |
---|---|---|---|
locationId | number | No | Unique location id generated from client location information |
location | Location | null | No | Location object provided by a client |
Property | Type | Required | Description |
---|---|---|---|
rootLocationId | string | No | Root location. |
appendLocation | boolean | No | Merge locations. |
Property | Type | Required | Description |
---|---|---|---|
id | string | No | Unique identifier for the location. |
locationName | string | No | Name of the location. |
version | Version | No | Version information provided by the user. |
[key: string] | any | No | Additional dynamic properties for the location. |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the reaction annotation |
metadata | BaseMetadata | No | Additional metadata |
icon | string | No | Icon for the reaction |
Name | Value | Description |
---|---|---|
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 |
Property | Type | Required | Description |
---|---|---|---|
commentId | string | number | Yes | Unique identifier for the comment |
commentHtml | string | No | HTML content of the comment |
commentText | string | No | Plain text content of the comment |
attachments | { [attachmentId: number]: PartialAttachment } | No | Map of attachment IDs to partial attachment data |
Property | Type | Required | Description |
---|---|---|---|
annotationId | string | Yes | ID of the comment annotation |
metadata | BaseMetadata | No | Additional metadata |
comments | Record<string, PartialComment> | Yes | Map of comment IDs to partial comments data |
Property | Type | Required | Description |
---|---|---|---|
url | string | Yes | URL of the attachment |
name | string | Yes | Name of the attachment |
attachmentId | number | Yes | Unique identifier for attachment |
Property | Type | Required | Description |
---|---|---|---|
attachmentId | number | Yes | Unique identifier for attachment |
file | File | Yes | File to be uploaded |
name | string | No | File name |
metadata | AttachmentResolverMetadata | No | Metadata of the attachment |
mimeType | string | No | Mime type of the attachment |
Property | Type | Required | Description |
---|---|---|---|
organizationId | string | null | Yes | ID of the organization |
documentId | string | null | Yes | ID of the document |
folderId | string | null | No | ID of the folder |
attachmentId | number | null | Yes | ID of the attachment |
commentAnnotationId | string | null | Yes | ID of the comment annotation |
apiKey | string | null | Yes | API key for authentication |
Property | Type | Required | Description |
---|---|---|---|
comment | CommentAnnotationDataProvider | No | Provider for comment annotation data |
user | UserDataProvider | No | Provider for user data |
reaction | ReactionAnnotationDataProvider | No | Provider for reaction annotation data |
attachment | AttachmentDataProvider | No | Provider for file attachment data |
Property | Type | Required | Description |
---|---|---|---|
resolveTimeout | number | No | Timeout duration (in milliseconds) for resolver operations |
saveRetryConfig | RetryConfig | No | Retry configuration for save operations |
deleteRetryConfig | RetryConfig | No | Retry configuration for delete operations |
getRetryConfig | RetryConfig | No | Retry configuration for get operations. Currently not supported for UserDataProvider. |
resolveUsersConfig | ResolveUsersConfig | No | Configuration for resolving users |
Property | Type | Required | Description |
---|---|---|---|
data | T | No | Response data of generic type T |
success | boolean | Yes | Whether the operation was successful |
message | string | No | Response message |
timestamp | number | No | Timestamp of the response |
statusCode | number | Yes | HTTP status code of the response |
Property | Type | Required | Description |
---|---|---|---|
retryCount | number | No | Number of retry attempts |
retryDelay | number | No | Delay between retry attempts in milliseconds |
revertOnFailure | boolean | No | Whether to revert changes on failure |
Property | Type | Required | Description |
---|---|---|---|
organization | boolean | No | Whether to resolve organization users |
folder | boolean | No | Whether to resolve folder users |
document | boolean | No | Whether to resolve document users |
Property | Type | Required | Description |
---|---|---|---|
get | (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>> | Yes | Function to fetch comment annotations |
save | (request: SaveCommentResolverRequest) => Promise<ResolverResponse<T>> | Yes | Function to save comment annotations |
delete | (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>> | Yes | Function to delete comment annotations |
config | ResolverConfig | No | Configuration for the data provider |
Property | Type | Required | Description |
---|---|---|---|
get | (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>> | Yes | Function to fetch reaction annotations |
save | (request: SaveReactionResolverRequest) => Promise<ResolverResponse<T>> | Yes | Function to save reaction annotations |
delete | (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>> | Yes | Function to delete reaction annotations |
config | ResolverConfig | No | Configuration for the data provider |
Property | Type | Required | Description |
---|---|---|---|
get | (userIds: string[]) => Promise<Record<string, User>> | Yes | Function to fetch user data by user IDs |
config | ResolverConfig | No | Configuration for the data provider |
Property | Type | Required | Description |
---|---|---|---|
save | (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>> | Yes | Function to save attachment data |
delete | (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>> | Yes | Function to delete attachment data |
config | ResolverConfig | No | Configuration for the data provider |
Property | Type | Required | Description |
---|---|---|---|
url | string | Yes | URL of the saved attachment |
Property | Type | Required | Description |
---|---|---|---|
userId | string | Yes | Unique user identifier |
name | string | No | User’s full name (Default: Random avatar name) |
email | string | No | User’s email address |
photoUrl | string | No | User’s display picture URL (Default: Random avatar image) |
onlineStatus | string | Yes | Online status (active, away, offline) (Auto generated) |
color | string | No | Assigned color for the user (Auto generated) |
timestamp | any | Yes | Server Timestamp |
type | string | No | User type |
selections | any | No | User selections |
documentParamsId | number | null | No | Deprecated unique document params ID |
documentParams | object | null | No | Deprecated document params |
locationId | number | null | No | Unique location ID |
location | Location | null | No | Location of user on sub document |
isReadOnly | boolean | No | Indicates if user is readonly |
isAnonymous | boolean | No | If user can only view comments (Anonymous) |
pageInfo | PageInfo | Yes | Information about the page |
isUserIdle | boolean | No | Indicates if user is idle. This is based on the inactivityTime configured in the Presence feature. (Auto generated) |
isTabAway | boolean | No | Indicates if user’s tab is unfocused. (Auto generated) |
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 ). |
Enum Name | Event Type | Description |
---|---|---|
USER_STATE_CHANGE | userStateChange | Triggered when a user’s online status changes to online, offline, or away |
Property | Type | Required | Description |
---|---|---|---|
documentId | string | No | ID of the document to query presence for. |
organizationId | string | No | ID of the organization to query presence for. |
statuses | string[] | No | Array of user statuses to filter by (e.g., ['online', 'away', 'offline'] ). |
Property | Type | Required | Description |
---|---|---|---|
data | PresenceUser[] | null | Yes | Array of PresenceUser objects. null while loading. |
Property | Type | Required | Description |
---|---|---|---|
event | string | Yes | The event type that triggered the webhook. |
actionType | string | Yes | The specific action that occurred. |
source | string | Yes | The source of the event. |
data | CommentPayload | HuddlePayload | Yes | The payload data containing event-specific information. |
webhookId | string | Yes | Unique identifier for the webhook. |
Property | Type | Required | Description |
---|---|---|---|
encodedPayload | string | Yes | Base64 encoded webhook payload. |
Property | Type | Required | Description |
---|---|---|---|
encryptedData | string | Yes | Encrypted webhook data. |
encryptedKey | string | Yes | Encrypted encryption key. |
iv | string | Yes | Initialization vector for decryption. |
Property | Type | Required | Description |
---|---|---|---|
commentAnnotation | CommentAnnotation | No | The comment annotation associated with the event. |
targetComment | Comment | No | The target comment for the event. |
actionUser | User | No | The user who performed the action. |
metadata | Metadata | No | Additional metadata about the event context. |
oldStatus | CommentStatus | No | Previous status of the comment (for status change events). |
newStatus | CommentStatus | No | New status of the comment (for status change events). |
newPriority | CommentPriority | No | New priority of the comment (for priority change events). |
Property | Type | Required | Description |
---|---|---|---|
actionUser | User | No | The user who performed the action. |
metadata | Metadata | No | Additional metadata about the event context. |
Property | Type | Required | Description |
---|---|---|---|
documentId | string | No | Document ID |
Property | Type | Required | Description |
---|---|---|---|
selected | boolean | Yes | Whether a comment is selected |
annotation | CommentAnnotation | Yes | Object data of the selected annotation |
Enum Name | Event Type | Description |
---|---|---|
ALL | all | Show all the contacts |
ORGANIZATION | organization | Show organization contacts. |
ORGANIZATION_USER_GROUP | organizationUserGroup | Show organization user groups. |
DOCUMENT | document | Show document contacts. |
Property | Type | Required | Description |
---|---|---|---|
userId | string | Yes | Unique user identifier that you use to identify your user. |
name | string | No | Your user’s full name. Default: Random avatar name. |
email | string | No | Your user’s email address. |
photoUrl | string | No | Your user’s display picture URL. Default: Random avatar image. |
comment | string | No | Short comment that user can add to their live cursor. |
onlineStatus | string | Yes | User’s online status (active, inactive, offline). Auto generated. |
color | string | No | A random color assigned to the user for the session, used on avatar border/live cursor. |
timestamp | any | Yes | Server Timestamp. |
type | string | No | User type. |
locationId | number | null | No | Unique location id from provided location. |
location | Location | null | No | Location to identify user on sub document. |
position | CursorPosition | null | No | User’s cursor position on their screen. |
isReadOnly | boolean | No | Indicates if user is readonly. |
isAnonymous | boolean | No | Indicates if user is anonymous and can only view comments. |
Property | Type | Required | Description |
---|---|---|---|
useHistoryAPI | boolean | Yes | Indicates whether the application should use the HTML5 History API for navigation |
onNavigate | (url: PageInfo) => void | No | A callback function that is called when navigation occurs. It takes a PageInfo object as its argument, which contains details about the new page |
disableDefaultNavigation | boolean | Yes | If true , the application’s default navigation handling is disabled, perhaps to be managed manually or by another system |
darkMode | boolean | Yes | A flag indicating whether the application should display in dark mode, a display preference that may be more comfortable for users in low-light conditions |
Property | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the version |
name | string | Yes | Name of the version |
Property | Type | Required | Description |
---|---|---|---|
actionUser | User | No | The user who performed the action |
recipientUser | User | No | The user receiving the notification |
actionMessage | string | No | The message describing the action |
project | string | No | The project related to the notification |
[key: string] | any | No | Any additional custom properties |
Property | Type | Required | Description |
---|---|---|---|
url | string | No | URL of the webpage |
path | string | No | Path of the webpage excluding base url |
baseUrl | string | No | Base URL (domain) of a webpage |
title | string | No | Title of the webpage |
commentUrl | string | No | Reference url of a comment annotation |
recorderUrl | string | No | Reference url of a recorder annotation |
screenWidth | number | No | User’s screen width. Auto generated. |
getThumbnailTag
MethodgetThumbnailTag
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).
Property | Type | Required | Description |
---|---|---|---|
annotationId | String | Yes | Unique identifier for the rewriter annotation, automatically generated. |
from | User | Yes | The user who created this rewriter annotation. |
color | String | No | Color used for the rewriter annotation. |
lastUpdated | Any | No | Timestamp when the rewriter annotation was last updated, automatically generated. |
documentParamsId | Number | null | No | Unique document params ID, deprecated, use locationId instead. |
documentParams | Location | null | No | Document params to identify user on sub document, deprecated, use location instead. |
locationId | Number | null | No | Unique location ID generated from provided location. |
location | Location | null | No | Set location to identify user on sub document. |
type | String | No | Type of annotation. |
rewriterType | String | Yes | Type of rewriter for the annotation, either ‘generic’ or ‘copywriter’. |
targetTextRange | TargetTextRange | null | No | Selected text range of rewriter annotation. |
annotationIndex | Number | No | Index of the current annotation in the list of annotations. |
pageInfo | PageInfo | No | Information about the page where the annotation is made. |
selectedRewriterOption | String | No | Selected rewriter option used in the annotation. |
Property | Type | Required | Description |
---|---|---|---|
playerId | String | No | The identifier for the video player instance. |
src | String | No | The source URL of the video. |
sources | String[] | No | An array of source URLs for the video. |
lastUpdated | Number | No | The timestamp of when the player was last updated. |
lastUpdatedBy | User | No | The user who last updated the player. |
lastUpdatedEvent | String | No | The name of the event that triggered the last update. |
playerState | SyncVideoPlayerState | Yes | The state object of the video player. |
Property | Type | Required | Description |
---|---|---|---|
playing | Boolean | No | Indicates if the video is currently playing. |
currentTime | Number | No | The current playback time of the video. |
muted | Boolean | No | Indicates if the video is muted. |
volume | Number | No | The volume level of the video. |
speed | Number | No | The playback rate of the video. |
Property | Type | Required | Default Value | Description |
---|---|---|---|---|
id | Number | No | None | A unique identifier for the toast notification. |
message | String | Yes | None | The message content displayed in the toast notification. |
type | ’success’ | ‘error’ | Yes | None | The type of toast notification, indicating success or error. |
duration | Number | No | 3000 | The length of time the toast notification is displayed, in milliseconds. |
Property | Type | Required | Description |
---|---|---|---|
from | User | Yes | The user who created the transcription. |
lastUpdated | Number | No | Timestamp of when the transcription was last updated. |
transcriptedText | String | No | The text that has been transcribed. |
Property | Type | Required | Description |
---|---|---|---|
userId | string | Yes | Unique user identifier used to identify your user. |
name | string | No | The full name of your user. Defaults to a random avatar name if not provided. |
photoUrl | string | No | The display picture URL of your user. Defaults to a random avatar image if not provided. |
email | string | No | Required for sending email or Slack notifications to users about comments and mentions. |
plan | string | No | The product plan the user is on. |
organizationId | string | Yes | organizationId to which the user belongs. |
color | string | No | A color assigned to the user for the current session, used for avatar border, live cursor, selection etc. |
textColor | string | No | Used in the text color of the user’s intial when photoUrl is not present. |
type | string | No | The type of user. |
isReadOnly | boolean | No | Indicates if the user has read-only access. |
isAnonymous | boolean | No | Indicates if the user is anonymous and can only view comments. |
isGuest | boolean | No | Indicates if the user is a guest. |
isAdmin | boolean | No | Use 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. |
groupId | string | No | [DEPRECATED] A domain name or identifier used to cluster a group of users who work together. |
clientGroupId | string | No | [DEPRECATED] The original groupId provided by the user. |
initial | string | No | First letter of the user’s first name. |
Property | Type | Required | Description |
---|---|---|---|
replaceContacts | boolean | No | If set to true, it will replace the user’s personal and group contacts with the ones provided. |
authToken | string | No | The authentication token of the user. |
Property | Type | Required | Description |
---|---|---|---|
contact | UserContact | Yes | Selected user contact details. |
isOrganizationContact | boolean | Yes | Is user part of organization contact. |
isDocumentContact | boolean | Yes | Is user part of document contact. |
documentAccessType | string | Yes | Document access type. |
Property | Type | Required | Description |
---|---|---|---|
id | string | No | Unique identifier of the feedback. |
apiKey | string | null | No | API key of the client. |
emailId | string | No | Email address of the feedback provider. |
message | string | No | Content of the user’s feedback message. |
from | User | null | No | User who submitted the feedback. |
lastUpdated | any | No | Timestamp of when the feedback was last updated. |
metadata | DocumentMetadata | null | No | Metadata associated with the document. |
pageInfo | PageInfo | No | Information about the user’s current page. |
Property | Type | Required | Description |
---|---|---|---|
id | string | No | Unique identifier of the feedback. |
apiKey | string | null | No | API key of the client. |
emailId | string | No | Email address of the feedback provider. |
message | string | No | Content of the user’s feedback message. |
from | User | null | No | User who submitted the feedback. |
lastUpdated | any | No | Timestamp of when the feedback was last updated. |
metadata | DocumentMetadata | null | No | Metadata associated with the document. |
pageInfo | PageInfo | No | Information about the user’s current page. |
Property | Type | Required | Description |
---|---|---|---|
count | number | Yes | The number of unread comments or threads. |
Property | Type | Required | Description |
---|---|---|---|
groupId | string | Yes | Unique identifier for the user group |
groupName | string | Yes | Display name of the user group |
users | User[] | No | Array of users that belong to this group |
Property | Type | Required | Description |
---|---|---|---|
id | string | No | The ID of the button to reset. If not provided, resets all buttons |
group | string | No | The group ID of buttons to reset. If not provided, resets buttons in all groups |