This server event occurs when any user creates a bookmark.
This event contains the following fields:
| Field | Description |
|---|---|
bookmark |
An object containing information about the bookmark. |
id |
The bookmark's identifier. |
name |
The bookmark's name. |
topic |
The bookmarked topic. |
tocId |
The bookmarked topic's identifier based on its position in the document's table of contents. |
title |
The bookmarked topic's title. |
mapId |
The bookmarked topic's map ID. |
mapTitle |
The bookmarked topic's map title. |
document |
The document where the bookmark was created. |
id |
The ID of the document where the bookmark was created. |
title |
The title of the document where the bookmark was created. |
type |
The type of the document where the bookmark was created. Always STRUCTURED_DOCUMENT. |
Since this event originates from the server and not the web application, it is not possible to listen to it.
A table for the most common fields is in Analytics events.
Example:
[
{
"bookmark": {
"id": "8aec697f-5b76-44df-b27f-3b2fead22cdd",
"name": "Examples of metadata keys and values",
"topic": {
"tocId": "CBbO~~MYyOE~3SHGRXSCzw",
"title": "Examples of metadata keys and values",
"mapId": "EIrDA_zzgkC3SgqNBybqGg",
"mapTitle": "Empower Metadata with Fluid Topics"
}
},
"document": {
"id": "EIrDA_zzgkC3SgqNBybqGg",
"title": "Empower Metadata with Fluid Topics",
"type": "STRUCTURED_DOCUMENT"
}
}
]