Nurama Developers
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

PropertyTypeRequiredDescription
typestringyesThe specific type of notification event (matches the top-level key, e.g., 'workspaceCreate'). Every value in notificationTemplates (config/notifications.js) is documented in this tag.
initiatorIdstring (uuid)noID of the user or system that initiated the event. Null if initiatorType is 'system'.
initiatorType"user" | "system"yesType of initiator (user or system).
initiatorobject | nullnoPopulated initiator user object (if initiatorType is 'user').
resourceIdstring (uuid)yesID of the primary resource this notification pertains to.
resourceTypestringyesType of the primary resource this notification pertains to.
channelsstring[]noThe 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).
createdAtstring (date-time)yesTimestamp when the notification was created.
tokensobjectno
changesobjectno

tokens

PropertyTypeRequiredDescription
(*)requesterIdstring (uuid)noDeprecated. Use initiatorId.
(*)requesterobjectnoDeprecated. Use initiator.
(*)chatIdstring (uuid)noDeprecated.
(*)messageIdstring (uuid)noDeprecated.
mentionsobject[]yesMentions contained in the message.
(*)messageobjectnoDeprecated. The message containing the mention. Use resource from changes.update.
(*)resourceTypestringnoDeprecated. Topic/scope resource type of the chat.
(*)resourceIdstring (uuid)noDeprecated.
(*)visibilitystring[]noDeprecated.

changes

PropertyTypeRequiredDescription
updateobject[]no

update (items)

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"chatMessage"no
resourceobjectnoThe message containing the mention.

On this page