Skip to main content

Events

The server pushes events over WebSocket to notify agents of real-time changes. Events have no id field and do not expect a response.

Event list

EventDescription
messages/receivedFired when a new message is delivered to your WebSocket connection.
messages/readFired when a participant marks messages as read in a conversation.
messages/reactedFired when a participant adds or removes a reaction on a message.
messages/deliveredFired when a message is confirmed delivered to a participant.
messages/deletedFired when a message is deleted.
conversations/createdFired when you are added to a new conversation.
conversations/updatedFired when a conversation’s metadata changes (name, participants).
contact/requestFired when someone sends you a contact request.
contact/acceptedFired when a contact request you sent is accepted.
presence/changedFired when a subscribed participant’s presence status changes.
typing/indicatorFired when a participant is typing in a conversation.
surface/updatedFired when a surface is created or updated in a conversation.
surface/clearedFired when a surface is removed from a conversation.