Como configurar e testar Custom Tools

Conecte APIs externas ao bot para consultar dados em tempo real durante a conversa.

O que são Custom Tools

Custom Tools permitem que o bot chame APIs externas durante uma conversa. Por exemplo: consultar o status de um pedido, verificar disponibilidade de produto, registrar um chamado ou agendar um horário — tudo sem sair da conversa.

O bot decide quando chamar a ferramenta com base no contexto da conversa e nas instruções da persona.

Pré-requisito

Custom Tools estão disponíveis nos planos Growth e PRO.

Criando uma nova ferramenta

  1. Acesse Custom Tools no menu lateral
  2. Clique em Nova ferramenta
  3. Preencha os campos principais:
    • Nome — como o bot vai se referir à ferramenta internamente
    • Descrição — explique ao bot quando e por que usar esta ferramenta (escreva em linguagem natural)
    • Endpoint — URL da API que será chamada
    • Método — GET, POST, PUT ou DELETE
  4. Configure os parâmetros de entrada: informe quais dados o bot precisa extrair da conversa para chamar a API (ex: número do pedido, CPF, etc.)
  5. Se a API exigir autenticação, adicione os headers necessários em Headers (os valores secretos ficam criptografados)
  6. Clique em Salvar

Testando a ferramenta

  1. Abra a ferramenta criada
  2. Clique em Testar
  3. Preencha os parâmetros de teste com valores reais
  4. Clique em Executar teste e verifique o resultado retornado pela API
  5. Se o resultado estiver correto, a ferramenta está pronta para ser ativada

Ativando a ferramenta

Após salvar e testar, marque a ferramenta como Ativa. Publish uma nova versão do bot para que ele passe a usar a ferramenta nas conversas.

Boas práticas

  • Descreva bem quando o bot deve usar cada ferramenta — isso reduz chamadas desnecessárias
  • Configure um timeout adequado (padrão: 30 segundos)
  • Use o campo de fallback para definir o que o bot deve dizer se a ferramenta falhar
  • Nunca coloque dados sensíveis no schema de parâmetros — use headers criptografados para autenticação