Nurama Developers
Notification types

convoUpdate

Fired when a convo is updated (subject / notes).

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

Fired when a convo is updated (subject / notes).

Payload for the convoUpdate 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
(*)convoIdstring (uuid)noDeprecated.
(*)chatIdstring (uuid)noDeprecated.
chatType"chat" | "chatMember" | "chatSubmission"yes
(*)userIdstring (uuid)noDeprecated.
userNamestringyes

changes

PropertyTypeRequiredDescription
updateobject | object | object[]no

update (items)

One of 3 variants:

Variant 1

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"convo"no
resourceobjectnoThe convo.

Variant 2

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"chat" | "chatMember" | "chatSubmission"no
resourceobjectnoThe chat the convo belongs to (resourceType is the chat model name).

Variant 3

PropertyTypeRequiredDescription
resourceIdstring (uuid)no
resourceType"chatMessage"no
resourceobjectnoThe system message posted to the chat for this event.

On this page