Notification types
fileSystemMove
Fired when items are moved to a new file system path.
Delivered as the
notification socket event with type set to fileSystemMove.Fired when items are moved to a new file system path.
Payload for the fileSystemMove event.
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 | Not populated for this event (the notification is created without a changes object). |
tokens
| Property | Type | Required | Description |
|---|---|---|---|
itemsCount | integer | yes | Number of items moved. |
itemPaths | string[] | yes | Original file system paths of the moved items. |
items | object[] | yes | The moved items by id, one entry per moved path. Only the items named in the request are listed, not the contents of a moved folder. The event's own resourceId is still the container (project, submission or public release). |
destinationPath | string | yes | Destination file system path where items were moved. |
items (items)
| Property | Type | Required | Description |
|---|---|---|---|
itemPath | string | no | Original file system path of the item (before the move). |
resourceId | string (uuid) | no | Id of the asset or folder at that path. |
resourceType | "asset" | "folder" | no |