Skip to main content
POST
/
webhooks
/
on-read
Webhook - When a message is read
curl --request POST \
  --url https://yourdomain.com/webhooks/on-read \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "+57",
  "cellphone": "3176477608",
  "session_id": "d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a",
  "conversation_id": 34820,
  "question": {
    "type": "open",
    "text": "Hello! Good morning. I hope everything is well. Would you like to continue our conversation to resolve all your problems and concerns?"
  },
  "sent_at": "2021-06-22 15:19:06.473256",
  "sent_text": "Hello! Good morning. I hope everything is well. Would you like to continue our conversation to resolve all your problems and concerns?",
  "user_session_keys": [],
  "read_at": "2021-06-22 15:19:08"
}'
{}

Body

application/json

Information of the read event

Event that is triggered when a message is read by the user

​
country_code
string
required

Country code of the user

​
cellphone
string
required

User's phone number without the country code

​
session_id
string
required

ID of the user's session

​
conversation_id
integer
required

ID of the conversation

​
question
object
required
​
sent_at
string<date-time>
required

Date and time when the message was sent

​
sent_text
string
required

Text of the sent message

​
read_at
string<date-time>
required

Date and time when the message was read by the user

​
user_session_keys
object[]

User session keys collected during the conversation or provided during the deployment

Response

200 - application/json

Response to update or add information to the session

JSON object with the new information that will be replaced or added to the session for future use. The service must respond in less than 10 seconds.

⌘I