Notification types
fileSystemUnpublish
Fired when multiple items are unpublished from file system paths.
Delivered as the
notification socket event with type set to fileSystemUnpublish.Fired when multiple items are unpublished from file system paths.
Fired when multiple items (assets/folders) are unpublished from file system paths.
Payload for the items unpublished 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 notification type is documented as its own event in this reference. |
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 |
|---|---|---|---|
(*)itemsCount | integer | no | Number of items unpublished. |
(*)itemPaths | string[] | no | File system paths of the unpublished items. |
changes
| Property | Type | Required | Description |
|---|---|---|---|
update | object[] | no |
update (items)
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "asset" | "folder" | no | |
resource | object | no |