Nurama Developers
Notification types

assetOriginalStateUpdate

Fired when the state of assets' originals changes — a prune requested, cancelled, done or failed, or the keep-original exemption toggled.

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

Fired when the state of assets' originals changes — a prune requested, cancelled, done or failed, or the keep-original exemption toggled.

One event can cover several assets (a bulk request), all moved to the same originalState by the same action. Each changed asset is in changes.update.

Payload for the assetOriginalStateUpdate event. Sent on the project's creator channel, and the asset's own channel when one asset changed.

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
(*)assetIdsstring (uuid)[]no
(*)originalState"stored" | "pruneRequested" | "pruning" | "pruned" | "restoring"noThe state the assets are now in.
(*)action"pruneRequested" | "pruneCancelled" | "pruned" | "pruneFailed" | "keepOriginalSet" | "keepOriginalCleared" | "reattachStarted" | "reattached" | "reattachRejected" | "reattachCancelled" | "reattachFailed"noThe history action that moved them there.

changes

PropertyTypeRequiredDescription
updateobject[]yes

update (items)

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"asset"no
resourceobjectno

On this page