> ## 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.

# Corpo da Solicitação Webhook de Leitura de Mensagem

> Este endpoint deve ser implementado no SEU servidor (por exemplo: https://seudominio.com/webhooks/on-read). O Treble chamará este webhook quando uma mensagem for lida pelo usuário. Você deve configurar a URL deste webhook no painel de administração do Treble.



## OpenAPI

````yaml open-api-files/treble-api-pt.json POST /webhooks/on-read
openapi: 3.0.1
info:
  title: API do Treble Poll
  description: Documentação para o endpoint de implantação de polls no Treble
  version: 1.0.0
servers:
  - url: https://main.treble.ai
    description: Servidor principal do Treble
  - url: https://seudominio.com
    description: >-
      Servidor de exemplo para implementar os webhooks. Isso representa SEU
      servidor onde você deve implementar os endpoints que o Treble chamará.
security: []
tags:
  - name: Webhooks
    description: >-
      Endpoints que o Treble chamará no seu servidor. Estes não são endpoints
      reais que você possa chamar, mas uma representação dos webhooks que o
      Treble invocará no seu sistema.
paths:
  /webhooks/on-read:
    post:
      tags:
        - Webhooks
      summary: Webhook - Quando uma mensagem é lida
      description: >-
        Este endpoint deve ser implementado no SEU servidor (por exemplo:
        https://seudominio.com/webhooks/on-read). O Treble chamará este webhook
        quando uma mensagem for lida pelo usuário. Você deve configurar a URL
        deste webhook no painel de administração do Treble.
      requestBody:
        description: Informações do evento de leitura
        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: Resposta para atualizar ou adicionar informações à sessão
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Objeto JSON com as novas informações que serão substituídas ou
                  adicionadas à sessão para uso futuro. O serviço deve responder
                  em menos de 10 segundos.
      servers:
        - url: https://seudominio.com
          description: Seu servidor onde você deve 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 é disparado quando uma mensagem é lida pelo usuário
      properties:
        country_code:
          type: string
          description: Código do país do usuário
        cellphone:
          type: string
          description: Número de telefone do usuário sem o código do país
        session_id:
          type: string
          description: ID da sessão do usuário
        conversation_id:
          type: integer
          description: ID da conversa
        question:
          $ref: '#/components/schemas/Question'
        sent_at:
          type: string
          format: date-time
          description: Data e hora em que a mensagem foi enviada
        sent_text:
          type: string
          description: Texto da mensagem enviada
        user_session_keys:
          type: array
          description: >-
            Chaves de sessão do usuário coletadas durante a conversa ou
            fornecidas durante a implantação
          items:
            $ref: '#/components/schemas/UserSessionKey'
        read_at:
          type: string
          format: date-time
          description: Data e hora em que a mensagem foi lida pelo usuário
    Question:
      type: object
      required:
        - type
        - text
      properties:
        type:
          type: string
          description: Tipo de pergunta
          example: open
        text:
          type: string
          description: Texto da pergunta
    UserSessionKey:
      type: object
      required:
        - key
        - value
      properties:
        key:
          type: string
          description: >-
            Nome da variável. Valores especiais incluem 'deployment_squad' para
            selecionar qual número de telefone realizará a implantação em
            empresas multicanal.
        value:
          type: string
          description: >-
            Valor da variável. Para 'deployment_squad', o valor deve ser
            'DS_[CELLPHONE]'.

````