> ## 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 Timeout (Fluxo Alternativo)

> Este endpoint deve ser implementado no SEU servidor (por exemplo: https://seudominio.com/webhooks/on-timeout). O Treble chamará este webhook quando ocorrer um timeout na conversa (o usuário não responde dentro do tempo estabelecido). Você deve configurar a URL deste webhook no painel de administração do Treble.

Você também pode configurar o webhook de resposta para o caminho que sai de um nó no caso de timeout, também conhecido como fluxo alternativo.

<img src="https://mintcdn.com/trebleai/og8nLWcDGdX1vO72/images/timeout-api-1.png?fit=max&auto=format&n=og8nLWcDGdX1vO72&q=85&s=8a81002020572ba265f9449e40d92576" alt="Configurar webhook do nó de timeout" width="2338" height="1348" data-path="images/timeout-api-1.png" />

Se você fizer isso, o corpo da solicitação HTTP que é enviado ao endpoint configurado no Treble adicionará o seguinte campo ao corpo da solicitação:

```json theme={null}
{
    "timeout_at": "2021-10-07 08:53:22.572123"
}
```

A resposta também pode ter novas variáveis para a sessão que podem ser atualizadas ou criadas para uso posterior na sessão. Ou seja, você pode adicioná-las na resposta do webhook como parte das `user_session_keys`.


## OpenAPI

````yaml open-api-files/treble-api-pt.json POST /webhooks/on-timeout
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-timeout:
    post:
      tags:
        - Webhooks
      summary: Webhook - Quando ocorre um timeout na conversa
      description: >-
        Este endpoint deve ser implementado no SEU servidor (por exemplo:
        https://seudominio.com/webhooks/on-timeout). O Treble chamará este
        webhook quando ocorrer um timeout na conversa (o usuário não responde
        dentro do tempo estabelecido). Você deve configurar a URL deste webhook
        no painel de administração do Treble.
      requestBody:
        description: Informações do evento de timeout
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeoutEvent'
            example:
              country_code: '+57'
              cellphone: '3161234567'
              session_id: abcsderfwer3252432423-1324325235
              conversation_id: 1234
              question:
                type: open
                text: Olá mundo
              timeout_at: '2021-10-07 08:53:22.572123'
              user_session_keys:
                - key: age
                  value: '18'
                  type: null
                - key: user_id
                  value: '12345'
                  type: null
      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:
    TimeoutEvent:
      type: object
      required:
        - country_code
        - cellphone
        - session_id
        - conversation_id
        - question
        - timeout_at
        - user_session_keys
      description: >-
        Evento que é disparado quando ocorre um timeout na conversa (o usuário
        não responde dentro do tempo estabelecido)
      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'
          description: Pergunta que não recebeu resposta a tempo
        timeout_at:
          type: string
          format: date-time
          description: Data e hora em que ocorreu o timeout
        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/ExtendedUserSessionKey'
    Question:
      type: object
      required:
        - type
        - text
      properties:
        type:
          type: string
          description: Tipo de pergunta
          example: open
        text:
          type: string
          description: Texto da pergunta
    ExtendedUserSessionKey:
      type: object
      required:
        - key
        - value
      properties:
        key:
          type: string
          description: Nome da variável
        value:
          type: string
          description: Valor da variável
        type:
          type: string
          nullable: true
          description: >-
            Tipo da variável. Pode ser null ou um tipo específico como
            'location'.

````