Nurama Developers
Notification types

convoStart

Fired when a convo (call) is started in a chat.

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

Fired when a convo (call) is started in a chat. Published on the chat channels and user/{userId} of the starter.

Payload for the convoStart 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
convoTypestringyes
(*)userIdstring (uuid)noDeprecated.
userNamestringyes
roomUrlstringyesURL of the call room.

changes

PropertyTypeRequiredDescription
createobject | object[]no
updateobject[]no

create (items)

One of 2 variants:

Variant 1

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

Variant 2

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

update (items)

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

On this page