> ## Documentation Index
> Fetch the complete documentation index at: https://help.treble.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cuerpo de la solicitud Webhook de lectura de mensaje

> Este endpoint debe ser implementado en TU servidor (por ejemplo: https://tudominio.com/webhooks/on-read). Treble llamará a este webhook cuando un mensaje sea leído por el usuario. Debes configurar la URL de este webhook en el panel de administración de Treble.



## OpenAPI

````yaml open-api-files/treble-api-es.json POST /webhooks/on-read
openapi: 3.0.1
info:
  title: API de Treble Poll
  description: Documentación para el endpoint de despliegue de polls en Treble
  version: 1.0.0
servers:
  - url: https://main.treble.ai
    description: Servidor principal de Treble
  - url: https://tudominio.com
    description: >-
      Servidor de ejemplo para implementar los webhooks. Esto representa TU
      servidor donde debes implementar los endpoints que Treble llamará.
security: []
tags:
  - name: Webhooks
    description: >-
      Endpoints que Treble llamará en tu servidor. Estos no son endpoints reales
      que puedas llamar, sino una representación de los webhooks que Treble
      invocará en tu sistema.
paths:
  /webhooks/on-read:
    post:
      tags:
        - Webhooks
      summary: Webhook - Cuando un mensaje es leído
      description: >-
        Este endpoint debe ser implementado en TU servidor (por ejemplo:
        https://tudominio.com/webhooks/on-read). Treble llamará a este webhook
        cuando un mensaje sea leído por el usuario. Debes configurar la URL de
        este webhook en el panel de administración de Treble.
      requestBody:
        description: Información del evento de lectura
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadEvent'
            example:
              country_code: '+57'
              cellphone: '3176477608'
              session_id: d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a
              conversation_id: 34820
              question:
                type: open
                text: >-
                  Olá! Bom dia. Espero que esteja tudo bem. Gostaria de
                  continuar nossa conversa para resolver todos os seus problemas
                  e preocupações?
              sent_at: '2021-06-22 15:19:06.473256'
              sent_text: >-
                Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar
                nossa conversa para resolver todos os seus problemas e
                preocupações?
              user_session_keys: []
              read_at: '2021-06-22 15:19:08'
      responses:
        '200':
          description: Respuesta para actualizar o agregar información a la sesión
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Objeto JSON con la nueva información que será reemplazada o
                  agregada a la sesión para uso futuro. El servicio debe
                  responder en menos de 10 segundos.
      servers:
        - url: https://tudominio.com
          description: Tu servidor donde debes implementar este webhook
components:
  schemas:
    ReadEvent:
      type: object
      required:
        - country_code
        - cellphone
        - session_id
        - conversation_id
        - question
        - sent_at
        - sent_text
        - read_at
      description: Evento que se dispara cuando un mensaje es leído por el usuario
      properties:
        country_code:
          type: string
          description: Código de país del usuario
        cellphone:
          type: string
          description: Número de teléfono del usuario sin el código de país
        session_id:
          type: string
          description: ID de la sesión del usuario
        conversation_id:
          type: integer
          description: ID de la conversación
        question:
          $ref: '#/components/schemas/Question'
        sent_at:
          type: string
          format: date-time
          description: Fecha y hora en que se envió el mensaje
        sent_text:
          type: string
          description: Texto del mensaje enviado
        user_session_keys:
          type: array
          description: >-
            Claves de sesión del usuario recopiladas durante la conversación o
            proporcionadas durante el despliegue
          items:
            $ref: '#/components/schemas/UserSessionKey'
        read_at:
          type: string
          format: date-time
          description: Fecha y hora en que el mensaje fue leído por el usuario
    Question:
      type: object
      required:
        - type
        - text
      properties:
        type:
          type: string
          description: Tipo de pregunta
          example: open
        text:
          type: string
          description: Texto de la pregunta
    UserSessionKey:
      type: object
      required:
        - key
        - value
      properties:
        key:
          type: string
          description: >-
            Nombre de la variable. Valores especiales incluyen
            'deployment_squad' para seleccionar qué número de teléfono realizará
            el despliegue en empresas multicanal.
        value:
          type: string
          description: >-
            Valor de la variable. Para 'deployment_squad', el valor debe ser
            'DS_[CELLPHONE]'.

````