Notification types
chatMention
Fired when user(s) are mentioned in a created or revised chat message.
Delivered as the
notification socket event with type set to chatMention.Fired when user(s) are mentioned in a created or revised chat message. Published only on the mentioned users' channels (user/{userId}).
Fired specifically when a user is mentioned in a chat message. Tokens are the same set as chatCreateMessage / chatReviseMessage.
Payload for the chatMention 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 |
|---|---|---|---|
(*)requesterId | string (uuid) | no | Deprecated. Use initiatorId. |
(*)requester | object | no | Deprecated. Use initiator. |
(*)chatId | string (uuid) | no | Deprecated. |
(*)messageId | string (uuid) | no | Deprecated. |
mentions | object[] | yes | Mentions contained in the message. |
(*)message | object | no | Deprecated. The message containing the mention. Use resource from changes.update. |
(*)resourceType | string | no | Deprecated. Topic/scope resource type of the chat. |
(*)resourceId | string (uuid) | no | Deprecated. |
(*)visibility | string[] | no | Deprecated. |
changes
| Property | Type | Required | Description |
|---|---|---|---|
update | object[] | no |
update (items)
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "chatMessage" | no | |
resource | object | no | The message containing the mention. |