Skip to content

conversation.read

POST

A user read a conversation up to a message.

webhook-id
required
string

Unique id of this delivery. Deduplicate on it.

webhook-timestamp
required
string

Unix time in seconds when the delivery was signed.

webhook-signature
required
string

Standard Webhooks signature, v1,<base64 HMAC-SHA256> of id.timestamp.body.

Media typeapplication/json
ConversationReadWebhook

A user read a conversation up to a message.

object
data
required
ConversationReadData

The event payload, with external ids.

object
conversation_id
required
Conversation Id

Conversation that was read.

string format: uuid
last_read_message_id
required
Last Read Message Id

Last message the reader has read.

string format: uuid
reader
required
Reader

External id of the user who read it.

string
timestamp
required
Timestamp

When the event was emitted.

string format: date-time
type
required
Type

Always conversation.read.

string
default: conversation.read
Allowed value: conversation.read

Any 2xx acknowledges it