Nurama Developers
Notification types

assetFileUpdate

Fired when a file associated with an asset is updated or added.

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

Fired when a file associated with an asset is updated or added.

Fired when a file associated with an asset is updated or added (e.g., thumbnail generated).

Payload for the asset file 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
(*)assetIdstring (uuid)no
(*)namestringno
keyPathstringyesThe S3 key path of the new/updated file.
functionTypestringyesThe role of the file (e.g., 'original', 'thumbnail', 'stream').
fileCountintegernoHow many files this event registered. A processor may register many outputs in one callback (an HLS ladder emits hundreds), in which case name, keyPath and functionType describe the LAST file of the batch and the full set is in changes.update[].resource.files. 1 for a single-file registration.

changes

PropertyTypeRequiredDescription
updateobject[]yes

update (items)

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

On this page