Skip to main content
Version: v2

SystemEvent

System message content. At least one field is non-empty

chatCreated object

System message: chat created

creatorMembershipIdstringrequired

Membership ID of the chat creator

Example: ADK5NyCqIK
membershipIdsstring[]

Array of Membership IDs of the created chat's members

Example: [ADK5NyCqIK, BDK5NyCqIK]
chatConvertedToPrivate object

System message: chat created

initiatorMembershipIdstringrequired

Membership ID of the initiator of converting the chat to private

Example: ADK5NyCqIK
membersJoined object

System message: new members joined the chat

inviterMembershipIdstring

Membership ID of the member who invited the new members

Example: ADK5NyCqIK
membershipIdsstring[]required

Array of Membership IDs of the invited members

Example: [ADK5NyCqIK, BDK5NyCqIK]
membersLeft object

System message: members removed from the chat

kickerMembershipIdstring

Membership ID of the member who removed the members

Example: ADK5NyCqIK
membershipIdsstring[]required

Array of Membership IDs of the removed members

Example: [ADK5NyCqIK, BDK5NyCqIK]
chatRenamed object

System message: chat renamed

initiatorMembershipIdstringrequired

Membership ID of the member who renamed the chat

Example: ADK5NyCqIK
newNamestringrequired

New chat name

Example: Documentation
SystemEvent
{
"chatCreated": {
"creatorMembershipId": "ADK5NyCqIK",
"membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
},
"chatConvertedToPrivate": {
"initiatorMembershipId": "ADK5NyCqIK"
},
"membersJoined": {
"inviterMembershipId": "ADK5NyCqIK",
"membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
},
"membersLeft": {
"kickerMembershipId": "ADK5NyCqIK",
"membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
},
"chatRenamed": {
"initiatorMembershipId": "ADK5NyCqIK",
"newName": "Documentation"
}
}