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
| Property | Type | Required | Description |
|---|---|---|---|
type | string | yes | The 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. |
initiatorId | string (uuid) | no | ID of the user or system that initiated the event. Null if initiatorType is 'system'. |
initiatorType | "user" | "system" | yes | Type of initiator (user or system). |
initiator | object | null | no | Populated initiator user object (if initiatorType is 'user'). |
resourceId | string (uuid) | yes | ID of the primary resource this notification pertains to. |
resourceType | string | yes | Type of the primary resource this notification pertains to. |
channels | string[] | no | The 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). |
createdAt | string (date-time) | yes | Timestamp when the notification was created. |
tokens | object | no | |
changes | object | no |
tokens
| Property | Type | Required | Description |
|---|---|---|---|
(*)assetId | string (uuid) | no | |
(*)name | string | no | |
keyPath | string | yes | The S3 key path of the new/updated file. |
functionType | string | yes | The role of the file (e.g., 'original', 'thumbnail', 'stream'). |
fileCount | integer | no | How 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
| Property | Type | Required | Description |
|---|---|---|---|
update | object[] | yes |
update (items)
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "asset" | no | |
resource | object | no |