Nurama Developers
Notification types

folderUpdate

Fired when a folder is renamed or recoloured (PUT /folders/{folderId}).

Delivered as the notification socket event with type set to folderUpdate.

Fired when a folder is renamed or recoloured (PUT /folders/{folderId}).

Fired when a folder is updated (name, color). resourceId is the folder id and resourceType is 'folder'. For a project folder it is sent on the folder's visibility channel only (project/{projectId}/creator or project/{projectId}/reviewer); folders owned by another resource use {ownerResourceType}/{ownerResourceId}.

Payload for the folder update event.

Token keys marked with (*) will be deprecated in a future release and should not be used for new development; replace them with the values and objects in the changes key in existing implementations.

Payload

PropertyTypeRequiredDescription
typestringyesThe specific type of notification event (matches the top-level key, e.g., 'workspaceCreate'). Every value in notificationTemplates (config/notifications.js) is documented in this tag.
initiatorIdstring (uuid)noID of the user or system that initiated the event. Null if initiatorType is 'system'.
initiatorType"user" | "system"yesType of initiator (user or system).
initiatorobject | nullnoPopulated initiator user object (if initiatorType is 'user').
resourceIdstring (uuid)yesID of the primary resource this notification pertains to.
resourceTypestringyesType of the primary resource this notification pertains to.
channelsstring[]noThe specific channels this notification was published on. Present on notification objects returned by the REST API only; the socket 'notification' payload omits it (and id).
createdAtstring (date-time)yesTimestamp when the notification was created.
tokensobjectno
changesobjectno

tokens

PropertyTypeRequiredDescription
(*)requesterIdstring (uuid)no
(*)requesterobjectno
(*)originalFolderobjectnoThe folder object before the update.
(*)updatedFolderobjectnoThe folder object after the update.

changes

PropertyTypeRequiredDescription
updateobject[]no

update (items)

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceTypestringno
resourceobjectno

On this page