Notification types
fileSystemDelete
Fired when items are deleted from file system paths.
Delivered as the
notification socket event with type set to fileSystemDelete.Fired when items are deleted from file system paths.
Payload for the fileSystemDelete 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 deleted. |
itemPaths | string[] | yes | File system paths of the deleted items. |
items | object[] | yes | The deleted items by id, one entry per deleted path. Only the items named in the request are listed, not the contents of a deleted folder. The event's own resourceId is still the container (project, submission or public release). |
items (items)
| Property | Type | Required | Description |
|---|---|---|---|
itemPath | string | no | File system path the item was deleted from. |
resourceId | string (uuid) | no | Id of the asset or folder at that path. |
resourceType | "asset" | "folder" | no |