Notification types
convoComplete
Fired when a convo is completed (ended by a user or when the last participant leaves).
Delivered as the
notification socket event with type set to convoComplete.Fired when a convo is completed (ended by a user or when the last participant leaves).
Payload for the convoComplete 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 |
|---|---|---|---|
(*)convoId | string (uuid) | no | Deprecated. |
(*)chatId | string (uuid) | no | Deprecated. |
(*)userId | string (uuid) | no | Deprecated. |
userName | string | yes | |
durationMinutes | number | yes | |
participantNames | string[] | yes |
changes
| Property | Type | Required | Description |
|---|---|---|---|
update | object | object | object[] | no |
update (items)
One of 3 variants:
Variant 1
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "convo" | no | |
resource | object | no | The convo. |
Variant 2
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "chat" | "chatMember" | "chatSubmission" | no | |
resource | object | no | The chat the convo belongs to (resourceType is the chat model name). |
Variant 3
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | |
resourceType | "chatMessage" | no | |
resource | object | no | The system message posted to the chat for this event. |