Notification types
iconUpdate
Generic event for when a workspace or project icon asset becomes active.
Delivered as the
notification socket event with type set to iconUpdate.Generic event for when a workspace or project icon asset becomes active. Includes the updated owner resource in changes.
Fired by the system when an icon asset's upload completes. changes.update contains the asset and the owning workspace/project.
Payload for the iconUpdate 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 |
|---|---|---|---|
(*)resourceType | "workspace" | "project" | no | Deprecated. |
(*)resourceId | string (uuid) | no | Deprecated. |
(*)asset | object | no | Deprecated. The asset object representing the new icon. |
changes
| Property | Type | Required | Description |
|---|---|---|---|
update | object | object[] | no |
update (items)
One of 2 variants:
Variant 1
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "asset" | no | |
resource | object | no | The icon asset. |
Variant 2
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "workspace" | "project" | no | |
resource | object | no | The owning resource with the new icon applied. |