Payload of the deprecated flat message.read webhook, fired when a creator reads a conversation, and its replacement creator.message.read.
message.read is the deprecated flat event for a creator marking a conversation as read. It requires the read:chat scope, and new integrations use creator.message.read instead.
Don’t build new integrations on message.read. It keeps firing during the migration window, after which only creator.message.read is delivered. Subscribe to creator.message.read and move existing consumers before the window closes.
message.read fires when a creator marks messages from a user as read. It is a per-conversation read receipt, reporting the read state of the single conversation between the creator and that user. There is no separate “notification read” event; message.read is the read signal available.
The eventId on message.read is a hash of the delivery tenants, the creator, the counterpart and the event type. It carries no per-occurrence component, so every read of the same conversation repeats the same id. Don’t use eventId alone as an idempotency key for this event; Read receipts gives the safe key. creator.message.read carries a distinct id per occurrence.
Use readMessagesCount to update local unread message counts without calling the /unread endpoint. When you receive this event, subtract readMessagesCount from your cached unread count for the given counterpartUuid.
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.
