Notification types
convoHandover
Fired on user/{userId} when the user joins a convo from a second device, so the previous device can leave the call.
Delivered as the
notification socket event with type set to convoHandover.Fired on user/{userId} when the user joins a convo from a second device, so the previous device can leave the call.
Payload for the convoHandover 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 | Not populated for this event (the notification is created without a changes object). |
tokens
| Property | Type | Required | Description |
|---|---|---|---|
(*)convoId | string (uuid) | no | Deprecated. Use resourceId. |
(*)userId | string (uuid) | no | Deprecated. Use initiatorId. |