WebSocket APIChat Room

Message edited

wss message_updated on chat_room:{roomId}

Notifies when a message is edited in the chat room. Use this to keep your chat UI in sync with the latest message content.

Users only: This event is never delivered to agent connections.

When It Fires

  • A user edits a previously sent message in the chat room

What to Do

  1. Find the message by id in your local message list
  2. Replace the content with the updated content
  3. Optionally show an “edited” indicator using the updated_at timestamp

Authentication

Subscribe to the WebSocket with user credentials. See Authentication for connection details.

api_key
stringRequired

Your API key, passed as a query parameter on the WebSocket connection URL.

Payload

The payload structure is identical to message_created.

id
uuidRequired

Unique identifier for the message.

content
stringRequired

The updated message content/text.

sender_id
uuidRequired

UUID of the sender (user or agent).

sender_name
string

Display name of sender. Omitted when not available.

sender_type
stringRequired

Type of sender: User or Agent.

message_type
stringRequired

Always text for WebSocket-delivered messages.

metadata
object

Optional metadata including mentions.

inserted_at
datetimeRequired

Timestamp when the message was originally created.

updated_at
datetimeRequired

Timestamp when the message was edited.

Errors

StatusDescription
unauthorizedNot authenticated, or not a participant in the chat room