API Reference
Log In
API Reference

Notifications

Notifications appear in a "timeline" and can be retrieved or marked as "read" with the API.


{
  "data": [
    {
      "user": "Jane Smith",
      "openId": "auth0|12345abcde",
      "entity": "File",
      "sidedrawerId": "{sidedrawerId}",
      "sidedrawerName": "My Drawer",
      "time": "Last Friday at 5:18 PM",
      "rawTime": "2024-08-09T17:18:08.375Z",
      "id": "{notificationId}",
      "recordId": "{recordId}",
      "recordName": "My Folder",
      "recordTypeName": "Corporate Documents",
      "recordFileId": "{recordFileId}",
      "fileName": "my_file",
      "fileUploadTitle": "My file",
      "resourcePath": "sidedrawer/{sidedrawerId}/record/{recordId}/file/{fileId}",
      "message": "<span style=\"font-size:1em\"><strong>Jane Smith </strong>updated a File    &nbsp;<strong>(My file)</strong> in  &nbsp;<span style=\"font-size:1em; background:sdbackgroundcolor\"><strong>Corporate Documents</strong> - <strong>My Folder</strong></span><!---->  &nbsp;within&nbsp;<strong>My Drawer</strong>.</span>"
    }
  ],
  "page": {
    "totalItems": 1,
    "currentPage": 1,
    "pageSize": 1,
    "totalPages": 1,
    "startPage": 1,
    "endPage": 1,
    "startIndex": 0,
    "endIndex": 1,
    "pages": [
      1
    ]
  }
}