Models
API Event Objects
Models
API Event Objects
Comments
Threads
AddCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
addContext | (context: any) => void | Yes | Function to add custom metadata |
elementRef | { xpath: string } | No | Reference to DOM element where comment annotation was added |
DeleteCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
Messages
AddCommentEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
comment | Comment | Yes | Comment Object |
metadata | VeltEventMetadata | Yes | Event metadata |
UpdateCommentEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
comment | Comment | Yes | Comment Object |
metadata | VeltEventMetadata | Yes | Event metadata |
DeleteCommentEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
comment | Comment | Yes | Comment Object |
metadata | VeltEventMetadata | Yes | Event metadata |
@Mentions
AssignUserEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
assignedTo | UserContact | Yes | User being assigned |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | No | Event metadata |
SubscribeCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
UnsubscribeCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
Attachments
AddAttachmentEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
attachments | AddAttachmentResponse[] | Yes | Array of attachment responses |
metadata | VeltEventMetadata | Yes | Event metadata |
AddAttachmentResponse
| Property | Type | Required | Description |
|---|---|---|---|
valid | boolean | Yes | Whether attachment is valid |
file | File | No | File object |
maxAllowedSize | number | Yes | Maximum allowed file size |
error | string | No | Error message if invalid |
attachment | Attachment | No | Attachment object |
DeleteAttachmentEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
attachment | Attachment | Yes | Attachment Object |
metadata | VeltEventMetadata | Yes | Event metadata |
Reactions
AddReactionEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
reaction | ReactionAnnotation | Yes | Reaction Object |
metadata | VeltEventMetadata | Yes | Event metadata |
DeleteReactionEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
reaction | ReactionAnnotation | Yes | Reaction Object |
metadata | VeltEventMetadata | Yes | Event metadata |
ToggleReactionEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
reaction | ReactionAnnotation | Yes | Reaction Object |
metadata | VeltEventMetadata | Yes | Event metadata |
Status & Priority
UpdateStatusEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
newStatus | CustomStatus | Yes | New status object |
oldStatus | CustomStatus | Yes | Previous status object |
metadata | VeltEventMetadata | Yes | Event metadata |
ResolveCommentEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
UpdatePriorityEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
newPriority | CustomPriority | No | New Priority object |
oldPriority | CustomPriority | No | Previous Priority object |
metadata | VeltEventMetadata | Yes | Event metadata |
ApproveCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
AcceptCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
actionUser | User | Yes | User who performed the action |
replaceContentHtml | string | No | HTML content to replace with |
replaceContentText | string | No | Text content to replace with |
RejectCommentAnnotationEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
metadata | VeltEventMetadata | Yes | Event metadata |
actionUser | User | Yes | User who performed the action |
replaceContentHtml | string | No | HTML content to replace with |
replaceContentText | string | No | Text content to replace with |
Recordings
DeleteRecordingEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
commentId | number | Yes | ID of the comment |
recording | RecordedData | Yes | Recording data |
metadata | VeltEventMetadata | Yes | Event metadata |
Deep Links
CopyLinkEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
link | string | Yes | Copied link |
metadata | VeltEventMetadata | Yes | Event metadata |
Access
UpdateAccessEvent
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentAnnotation | CommentAnnotation | Yes | Comment annotation object |
newAccessMode | CommentAccessMode | No | New access mode |
oldAccessMode | CommentAccessMode | No | Previous access mode |
metadata | VeltEventMetadata | Yes | Event metadata |
VeltEventMetadata
| Property | Type | Required | Description |
|---|---|---|---|
organizationMetadata | OrganizationMetadata | null | No | Organization metadata |
documentMetadata | DocumentMetadata | null | No | Document metadata |
location | Location | null | No | Location information |
Was this page helpful?