Receive notification

server → client on the resource channel.

Envelope event on which every notification listed in this section is delivered. The type property tells you which event schema applies.

Emitted on every channel (namespace) listed in the notification's channels array. Unlike the REST notification objects, the socket payload does NOT include id or channels. tokens and changes are shaped per event type as documented under each event.

Envelope: `notification`

Payload of the 'notification' socket event.

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	Event specific tokens (see the individual event).
`changes`	`object \| null`	no	Event specific create/update/delete arrays (see the individual event). May be null.

Notification types

`type`	Summary
`test`	Event used for testing websocket connections.
`notificationUpdate`	Indicates that a previously delivered, grouped notification has been updated (assetGroupUploadComplete or projectGroupItemPublish).
`workspaceCreate`	Fired when a new workspace is created.
`workspaceUpdate`	Fired when a workspace name is changed.
`workspaceDelete`	Fired when a workspace is marked for deletion.
`workspaceLogoUpdate`	CURRENTLY UNUSED IN FAVOR OF logoUpdate event. Fired when a workspace logo is updated.
`projectCreate`	Fired when a new project is created.
`projectUpdate`	Fired when a project name is changed.
`projectDelete`	Fired when a project is marked for deletion.
`projectLogoUpdate`	CURRENTLY UNUSED IN FAVOR OF logoUpdate event. Fired when a project logo is updated. Updates the project and returns the new asset object for the logo. Note that the logo will not be 'active' until the actual file is uploaded. So you will need to watch for updates to this asset before replacing the logo locally.
`projectAssetsPublish`	CURRENTLY UNUSED (the event type is still registered but nothing emits it). Fired when assets within a project are published.
`projectAssetsUnpublish`	CURRENTLY UNUSED (the event type is still registered but nothing emits it). Fired when assets within a project are unpublished.
`assetNameChange`	Fired when an asset's name is changed.
`assetPublish`	Fired for each individual asset published through the project publish flow (accompanies fileSystemPublish / projectItemsPublish).
`assetUnpublish`	Fired for each individual asset unpublished through the project unpublish flow (accompanies fileSystemUnpublish / projectItemsUnpublish).
`assetTag`	Fired when a tag is added to an asset.
`assetUntag`	Fired when a tag is removed from an asset.
`assetDelete`	Fired when an asset is deleted.
`assetStatusUpdate`	Fired when an asset's status changes (e.g., during processing).
`assetPostProcessUpdate`	Fired periodically during asset post-processing (e.g., transcoding).
`assetFileUpdate`	Fired when a file associated with an asset is updated or added.
`assetGroupUploadComplete`	Fired when an uploaded asset becomes active. Uploads by the same creator into the same resource/visibility within the grouping window (30 min) are accumulated into one notification, which is then re-sent via notificationUpdate.
`chatTopicChatCreate`	Fired when a new topic-based chat is created.
`chatMemberChatCreate`	Fired when a new member-based chat (DM/group) is created.
`chatUpdateSubject`	Fired when the subject of a topic-based chat is updated.
`chatMemberUpdate`	Fired when a member chat's subject or colour is updated.
`chatDelete`	Fired when a topic-based chat is deleted.
`chatMemberDelete`	Fired when a member-based chat is deleted.
`chatCreateMessage`	Fired when a new message is created in a chat (user messages, public/guest messages, AI assistant replies and system messages).
`chatReviseMessage`	Fired when a chat message is revised (edited).
`chatRefreshMessage`	Provides an updated representation of a system message (e.g. after the assets it references finish processing).
`chatMention`	Fired when user(s) are mentioned in a created or revised chat message. Published only on the mentioned users' channels (user/{userId}).
`chatDeleteMessage`	Fired when a chat message is deleted.
`chatRemoveAttachment`	Fired when an attachment is removed from a chat message.
`folderCreate`	CURRENTLY UNUSED (the event type is still registered but nothing emits it). Fired when a new folder is created.
`folderUpdate`	CURRENTLY UNUSED (the event type is still registered but nothing emits it). Fired when a folder is updated.
`folderDelete`	CURRENTLY UNUSED (the event type is still registered but nothing emits it). Fired when a folder is deleted.
`inviteCreate`	Fired when a new invitation is created.
`inviteCancel`	Fired when an invitation is cancelled.
`inviteAccept`	Fired when an invitation is accepted.
`membershipDelete`	Fired when a user's membership to a resource is deleted (removed).
`membershipAddRole`	Fired when a role is added to a user's membership.
`membershipRemoveRole`	Fired when a role is removed from a user's membership.
`membershipLeaveResource`	Fired when a user leaves a resource themselves.
`workspaceStorageLimitWarning`	Fired when a workspace's storage usage exceeds a threshold.
`userSelfUpdate`	Fired when a user updates their own profile information.
`userPublicUpdate`	Fired when a user's public information is updated.
`userDeleted`	Fired when a user account is deleted.
`userAvatarUpdate`	Fired when a avatars status is set to active. Note that this is an asset event and not a user event so it is fired when the asset's status is set to active not when a user's object is updated.
`logoUpdate`	Generic event for when a workspace or project logo asset becomes active. Includes the updated owner resource in changes.
`iconUpdate`	Generic event for when a workspace or project icon asset becomes active. Includes the updated owner resource in changes.
`taskAcknowledged`	Fired when tasks are acknowledged within a project.
`taskStatusUpdate`	Fired when the status of a task is updated.
`taskCreate`	Fired when a new task is created within a project.
`notificationUpdateLastSeen`	Fired to update a client's 'last seen' timestamp for notifications.
`submissionCreate`	Fired when a submission is released for the first time. Published on project/{projectId}, project/{projectId}/creator and project/{projectId}/reviewer.
`projectItemsPublish`	Fired when multiple items (assets/folders) within a project are published.
`projectItemsUnpublish`	Fired when multiple items (assets/folders) within a project are unpublished.
`folderPublish`	Fired when an individual folder is published.
`folderTag`	Fired when a tag is added to a folder.
`folderUntag`	Fired when a tag is removed from a folder.
`tagCreate`	Fired when a new tag is created.
`tagUpdate`	Fired when a tag is updated.
`tagDelete`	Fired when a tag is deleted.
`fileSystemCreate`	Fired when items are created at a file system path (folder created, single uploaded asset activated, or items copied into a public release).
`fileSystemMove`	Fired when items are moved to a new file system path.
`fileSystemCopy`	Fired when items are copied to a new file system path.
`fileSystemDelete`	Fired when items are deleted from file system paths.
`fileSystemPublish`	Fired when multiple items are published at a file system path.
`fileSystemUnpublish`	Fired when multiple items are unpublished from file system paths.
`subscriptionCreate`	Fired when a new billing subscription is created for a workspace (Stripe webhook). Published on user/{ownerId} and {resourceType}/{resourceId}.
`subscriptionUpdate`	Fired when an existing billing subscription is updated, paused, resumed or deleted (Stripe webhook). Published on user/{ownerId} and {resourceType}/{resourceId}.
`projectGroupItemPublish`	Grouped notification for items published in a project. Items published by the same user within the grouping window (30 min) are accumulated and re-sent via notificationUpdate.
`publicAssetLinkCreate`	Fired when a public (share) link is created for an asset. Published on project/{projectId}/creator and workspace/{workspaceId}.
`uploadPushSummary`	Delayed push-notification summary of assets uploaded to a project by one user. Primarily used to send a push notification after scheduledSendAt, but also broadcast on the project visibility channels when created.
`publishPushSummary`	Push-notification summary of items published to reviewers. Used to send a push notification; broadcast on project/{projectId}/reviewer.
`submissionPushSummary`	Push-notification summary for a newly created submission. Used to send a push notification; broadcast on project/{projectId}.
`memberJoinPush`	Push-notification record created when a user joins a workspace or project. Used to send a push notification; broadcast on {resourceType}/{resourceId}.
`chatMemberArchive`	Fired when the requesting user archives a member chat for themselves. Published on user/{userId} only.
`chatMemberUnarchive`	Fired when the requesting user un-archives a member chat for themselves. Published on user/{userId} only.
`chatHighlightMessage`	Fired when a message in a project-scoped chat is highlighted. Published on project/{projectId}/{visibility} of the chat.
`chatFollow`	Fired when a user follows a chat. Published on the chat channels.
`chatUnfollow`	Fired when a user unfollows a chat. Published on the chat channels.
`userEmailVerify`	Fired when a user's email address is verified. Published on user/{userId}.
`botCreate`	Fired when a bot user is created in a workspace. Published on workspace/{workspaceId}.
`webhookTest`	Synthetic event fired when an admin tests a webhook subscription. Published on workspace/{workspaceId}; delivered by the webhook dispatcher as webhook.test.
`taskFollow`	Fired when a user follows a task.
`taskUnfollow`	Fired when a user unfollows a task.
`submissionUpdate`	Fired when an already-released submission is re-released. Published on project/{projectId}, project/{projectId}/creator and project/{projectId}/reviewer.
`submissionTag`	Fired when a tag is added to a submission. resourceType is chatSubmission.
`submissionUntag`	Fired when a tag is removed from a submission. resourceType is chatSubmission.
`aiChatTopicCreate`	Fired when an AI chat topic is created. Published on user/{userId} of the topic owner.
`aiChatTopicUpdate`	Fired when an AI chat topic is updated (title, archive state, context items, last message preview) or deleted. Published on user/{userId} of the topic owner.
`aiChatMessageCreate`	Fired when the AI assistant posts a message in an AI chat topic. Published on user/{userId} of the topic owner.
`publicFileSystemCreate`	Fired when a public release (public file system) is created. Published on project/{projectId}/creator.
`publicFileSystemUpdate`	Fired when a public release is updated (title, description, validity, options). Published on project/{projectId}/creator.
`publicFileSystemDelete`	Fired when a public release is deleted. Published on project/{projectId}/creator.
`settingsUpdate`	Fired when a user's settings for a resource are updated or reset. Published on user/{userId} only.
`convoStart`	Fired when a convo (call) is started in a chat. Published on the chat channels and user/{userId} of the starter.
`convoJoin`	Fired when a user joins a convo.
`convoLeave`	Fired when a user leaves a convo.
`convoComplete`	Fired when a convo is completed (ended by a user or when the last participant leaves).
`convoUpdate`	Fired when a convo is updated (subject / notes).
`convoDelete`	Fired when a convo is deleted.
`convoParticipantJoined`	Fired (from the call-provider webhook) when a participant actually joins the call room.
`convoParticipantLeft`	Fired (from the call-provider webhook) when a participant leaves the call room.
`convoHandover`	Fired on user/{userId} when the user joins a convo from a second device, so the previous device can leave the call.
`boardCreate`	Fired when a kanban board is created. Published on the project visibility channels of the board.
`boardUpdate`	Fired when a kanban board is updated (name, visibility, options).
`boardDelete`	Fired when a kanban board is deleted. Cascaded task deletions / reassignments are included in changes.
`boardTaskCreate`	Fired when a task is created on a board (UI, AI tool or bulk create). Also used for push notifications.
`boardTaskMove`	Fired when a task is moved between columns or boards. Published on the visibility channels of both boards for cross-board moves.
`boardTaskAssign`	Fired when a task is assigned or unassigned. Published on the board visibility channels and user/{assignedToId}.
`boardColumnAdd`	Fired when a column is added to a board.
`boardColumnUpdate`	Fired when a board column is updated.
`boardColumnDelete`	Fired when a board column is deleted.
`boardColumnReorder`	Fired when the columns of a board are reordered. changes.update contains every column with its new order.
`boardTaskAdd`	Fired when an existing task is added to a board.
`boardTaskRemove`	Fired when a task is removed from a board (the task itself is kept).
`boardTaskUpdate`	Fired when a task's details are updated (subject, description, priority, dates, etc.).
`boardTaskLink`	Fired when two tasks are linked.
`boardTaskUnlink`	Fired when a task link is removed.
`boardTaskRelationAdd`	Fired when a resource (asset, folder, message, chat, ...) is related to a task. Also used for push notifications.
`boardTaskRelationRemove`	Fired when a task relation is removed (explicitly, or cascaded when a board visibility change removes access).
`boardFollow`	Fired when a user follows a board.
`boardUnfollow`	Fired when a user unfollows a board.

Envelope: notification

Notification types

On this page

Envelope: `notification`