Nurama Developers
Notification types

chatHighlightMessage

Fired when a message in a project-scoped chat is highlighted.

Delivered as the notification socket event with type set to chatHighlightMessage.

Fired when a message in a project-scoped chat is highlighted. Published on project/{projectId}/{visibility} of the chat.

Payload for the chatHighlightMessage 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.
(*)projectIdstring (uuid)noDeprecated.

changes

PropertyTypeRequiredDescription
updateobject | object[]no

update (items)

One of 2 variants:

Variant 1

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"chat"no
resourceobjectnoThe chat containing the highlighted message.

Variant 2

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"chatMessage"no
resourceobjectnoThe highlighted message.

On this page