Notification types
fileSystemCreate
Fired when items are created at a file system path (folder created, single uploaded asset activated, or items copied into a public release).
Delivered as the
notification socket event with type set to fileSystemCreate.Fired when items are created at a file system path (folder created, single uploaded asset activated, or items copied into a public release).
Signals clients to refresh the destination path. The changes object is usually absent; it is populated only for the single-asset activation (create asset) and public release (update public) cases.
Payload for the fileSystemCreate event.
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 | Optional. Present only in some code paths (see description). |
tokens
| Property | Type | Required | Description |
|---|---|---|---|
itemsCount | integer | yes | Number of items created. |
destinationPath | string | yes | File system path where items were created (e.g. 'project/{projectId}/creator/{basePath}'). |
changes
| Property | Type | Required | Description |
|---|---|---|---|
create | object[] | no | |
update | object[] | no |
create (items)
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "asset" | no | |
resource | object | no | The activated asset (upload completion path). |
update (items)
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "public" | no | |
resource | object | no | The public release record with recalculated inventory (add-items-to-release path). |