Skip to main content

Notifications

CO server provides push notifications service indented to notify client about changes made to the cloud file system to perform well-timed user UI update as well as about async file operations results such as import/export, printing etc.

Notifications are sent via the websocket channel and each notification payload contains JSON object with following fields

FieldDescription
operationName of the performed operation
objectIdID of the file object
dirIdSource or target folder ID (depends on the file operation)
destDirIdTarget folder ID
objectNameName of the file object
sourceIdID of the source file used for conversion (may be hidden one)
usedBytesUsed disk space
totalBytesTotal disk space
revisionIdRevision id
emailEmail for operation [Since 2018.03]
loginLogin of initiator for operation [Since 2019.01]
newIdNew file id if it is changed during operation (e.g. move from shared) [Since 2019.03]
timeTime of initiation for operation [Since 2020.01]
requestIdID of the user initiated operation. Returned in the X-co-request-id header in the response to synchronous API request.
errorCodeSRV error code.
groupFor group shared notifications will be true if it is group sharing.
userIdUser id for shared notifications. For group shared notifications will contain groupId.
changedValuesMap with changed file properties for FILE_METADATA_CHANGE and FILE_CUSTOM_PROPS_CHANGE (such as fileNameChanged, fileCorrupted).
customPropertiesMap with custom file properties.
deletedKeysList of deleted file properties for FILE_CUSTOM_PROPS_CHANGE.