Data Models
Notification
Notification Class Properties
| Property | Type | Optional | Description |
|---|---|---|---|
id | string | No | Notification ID |
notificationSource | string | No | Notification source. e.g., ‘comment’, ‘custom’, etc. |
actionType | string | Yes | Action that triggered the notification. e.g., ‘added’ |
isUnread | boolean | Yes | Whether the notification is unread for the user |
actionUser | User | Yes | The user who triggered the action |
timestamp | number | Yes | Timestamp of the notification |
displayHeadlineMessage | string | Yes | The headline message of the notification |
displayBodyMessage | string | Yes | The body message of the notification |
displayHeadlineMessageTemplate | string | Yes | The template of the headline message |
displayHeadlineMessageTemplateData | object | Yes | The data used to fill the headline message template |
forYou | boolean | Yes | Whether the notification is for the current logged-in user |
targetAnnotationId | string | Yes | ID of the annotation that triggered the notification |
notificationSourceData | any | Yes | The data of the notification source. e.g., CommentAnnotation |
metadata | NotificationMetadata | Yes | Metadata for the current notification. e.g., documentId |
notifyUsers | { [emailHash: string]: boolean } | Yes | Map of email hashes to boolean values indicating whether to notify the user |
notifyUsersByUserId | { [userIdHash: string]: boolean } | Yes | Map of user ID hashes to boolean values indicating whether to notify the user |
displayHeadlineMessageTemplateData Object Properties
| Property | Type | Description |
|---|---|---|
actionUser | User | The user who performed the action |
recipientUser | User | The user receiving the notification |
actionMessage | string | The message describing the action |
project | string | The project related to the notification |
[key: string] | any | Any additional custom properties |
NotificationMetadata Properties
| Property | Type | Optional | Description |
|---|---|---|---|
apiKey | string | Yes | Your API key |
clientOrganizationId | string | Yes | The organization ID that you set |
organizationId | string | Yes | The organization ID generated by us |
clientDocumentId | string | Yes | The document ID that you set |
documentId | string | Yes | The document ID generated by us |
locationId | number | Yes | The unique location ID |
location | Location | Yes | The location object |
documentMetadata | Object | Yes | Contains the complete document metadata object |
organizationMetadata | Object | Yes | Contains the complete organization metadata object |
Was this page helpful?