Skip to main content
The ConversationUnread event fires each time the unread state of a conversation changes — for example, when a new inbound message marks a conversation as unread, or when a user reads a conversation and the count returns to zero. Use it to drive notification badges, sync read/unread state to external helpdesk tools, or trigger follow-up workflows when conversations go unattended.

​
Payload

FieldTypeDescription
typestringAlways "ConversationUnreadWebhook"
locationIdstringSub-account ID where the conversation lives
idstringUnique identifier of the conversation
contactIdstringID of the contact associated with the conversation
unreadCountnumberCurrent number of unread messages in the conversation; 0 means the conversation has been read
inboxbooleanWhether the conversation is currently in the inbox view
starredbooleanWhether the conversation has been starred by a user
deletedbooleanWhether the conversation has been deleted

​
Example payload

{
  "type": "ConversationUnreadWebhook",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "id": "BqTwX8QFwXzpegMve9EQ",
  "contactId": "nmFmQEsNgz6AVpgLVUJ0",
  "unreadCount": 0,
  "inbox": false,
  "starred": true,
  "deleted": false
}
  • Inbound Message — fires when a contact sends a message, which typically increments the unread count
  • Outbound Message — fires when a user sends a message to a contact
  • Conversations API — query conversations and messages programmatically
Last modified on March 4, 2026