Skip to main content
Last updated on July 3, 2025

Chat Events 0.1.0 documentation

Published Messages (personalChat)

The service publishes one of these messages below.

personalChatSent

Contains fields from event and the following payload.

Example value
{
"payload": {
"personalChatSent": {
"message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",
"sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
"target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
"payload": "string",
"target_type": "string",
"target_members": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
personalChatSentobject-
payload.personalChatSent
NameTypeDescription
message_idstring (uuid)-
sender_idstring (uuid)-
target_idstring (uuid)Can be partyId or userId
payloadstring-
target_typestring-
target_membersarray-

Published Messages (chat)

The service publishes one of these messages below.

userConnected

Contains fields from event and the following payload.

Example value
{
"payload": {
"userConnected": {}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userConnectedobject-
payload.userConnected

This is a free-form object.

userDisconnected

Contains fields from event and the following payload.

Example value
{
"payload": {
"userDisconnected": {
"reason": "string",
"code": 0,
"forced": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userDisconnecteduserPayloadDisconnected-

userChatRateLimited

Contains fields from event and the following payload.

Example value
{
"payload": {
"userDisconnected": {
"reason": "string",
"code": 0,
"forced": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userDisconnecteduserPayloadDisconnected-

Schemas

userPayloadDisconnected

NameTypeDescription
reasonstring-
codeinteger-
forcedboolean-

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstringUserId of the operator for this event (optional)
traceIdstring-
sessionIdstring-
spanContextstring-