Os Custom Tools permitem que o WootAI se conecte às APIs da sua empresa durante as conversas.
Com isso, o WootAI pode:
-
consultar status de garantia;
-
verificar cobertura de atendimento;
-
buscar informações em sistemas internos;
-
consultar dados em tempo real;
-
automatizar processos sem precisar transferir para um agente humano.
Quando um cliente faz uma pergunta, o WootAI identifica automaticamente as informações relevantes da conversa, envia esses dados para sua API e utiliza a resposta para gerar uma resposta inteligente ao cliente.
Como criar um Tool
Acesse:
WootAI → Tools
Depois clique em Criar novo Tool.
Campos necessários para criar um Tool
Nome do Tool
Um nome curto e objetivo.
Exemplos:
-
Warranty Lookup
-
Service Area Check
Descrição
Este é o campo mais importante.
Descreva claramente quando o WootAI deve utilizar esse Tool.
Escreva como se estivesse orientando um agente de suporte.
✅ Exemplo bom:
“Verifica o status de garantia de um produto usando o número de série.”
❌ Exemplo ruim:
“API de garantia”
Descrições vagas dificultam o entendimento do WootAI sobre quando utilizar o Tool.
Método
Escolha o tipo de requisição da API:
-
GET → para buscar informações
-
POST → para enviar informações
URL do Endpoint
Informe a URL da sua API.
Você pode utilizar parâmetros dinâmicos usando:
{{ parameter_name }}
Exemplo:
https://api.suaempresa.com/v1/warranty/{{ serial_number }}
Requisitos da URL:
-
deve utilizar HTTPS;
-
deve possuir domínio válido;
-
não pode utilizar localhost;
-
não pode utilizar IP privado.
Autenticação
Escolha como sua API autentica as requisições.
Opções disponíveis:
-
Nenhuma
-
Bearer Token
-
Basic Auth
-
API Key
Bearer Token
Envia o token no header Authorization.
Basic Auth
Envia usuário e senha.
API Key
Envia um cabeçalho personalizado.
Exemplo:
X-API-Key
As credenciais de autenticação ficam visíveis apenas para administradores da conta.
Parâmetros
Defina quais informações o WootAI deve extrair da conversa.
Cada parâmetro precisa ter:
-
nome;
-
tipo;
-
descrição.
Exemplo:
serial_number (String)
Número de série do produto localizado na parte traseira do dispositivo.
Template da Requisição (POST)
Para métodos POST, você pode definir um template JSON utilizando sintaxe Liquid.
Template da Resposta
O Response Template controla exatamente quais informações o WootAI irá receber da resposta da API.
Se deixado vazio, o WootAI receberá o JSON bruto completo.
Você pode usar Liquid para selecionar apenas os campos relevantes.
Exemplo:
Serial {{ response.serial_number }}:
{{ response.warranty_status }}
Expira em:
{{ response.expiry_date }}
Utilize:
response
para acessar os dados retornados pela API.
Os templates ajudam o WootAI a focar apenas nas informações importantes, evitando campos internos como IDs de banco de dados ou dados de debug.
Testando o Tool
Clique em Testar conexão antes de salvar.
O sistema verificará:
-
se o endpoint está acessível;
-
se a autenticação funciona corretamente;
-
se a API responde adequadamente.
Se houver erro:
-
verifique credenciais;
-
confirme a URL;
-
valide se a API está online;
-
confira o tempo de resposta do endpoint.
Informações enviadas em cada chamada da API
Quando o WootAI chama sua API, alguns headers adicionais são enviados automaticamente para fornecer contexto da conversa.
Exemplos:
-
ID da conta;
-
ID da conversa;
-
e-mail do cliente;
-
telefone do cliente;
-
ID do contato;
-
assistant responsável;
-
identificação do Tool;
-
verificação de identidade do contato.
Esses dados permitem:
-
localizar clientes no seu sistema;
-
registrar chamadas da API;
-
rastrear interações;
-
validar autenticidade das requisições.
Segurança
Os Custom Tools possuem diversas proteções integradas.
HTTPS obrigatório
Todos os endpoints precisam utilizar HTTPS.
Bloqueio de redes privadas
Requisições para:
-
localhost;
-
IPs privados;
-
domínios
.local;
são bloqueadas automaticamente.
Proteção de credenciais
As credenciais ficam visíveis apenas para administradores.
Verificação de identidade
Se sua API retorna dados sensíveis, como:
-
pedidos;
-
cobranças;
-
informações da conta;
é recomendado validar se o contato foi autenticado corretamente antes de retornar os dados.
Proteção contra Prompt Injection
Caso sua API retorne conteúdo gerado por usuários, como:
-
avaliações;
-
comentários;
-
posts;
textos maliciosos podem tentar influenciar o comportamento do WootAI.
Para evitar isso:
-
utilize Response Templates;
-
retorne apenas campos estruturados;
-
sanitize conteúdos na sua API.
Quando usar Custom Tools
Custom Tools funcionam melhor para consultas estruturadas e previsíveis.
Exemplos ideais:
-
verificar status;
-
consultar garantias;
-
buscar registros;
-
consultar agendas;
-
validar cobertura;
-
consultar informações por ID.
Exemplos de uso
Warranty Lookup
Quando um cliente pergunta se um produto ainda está na garantia, o WootAI pode consultar automaticamente usando o número de série.
Nome do Tool
Warranty Lookup
Descrição
Verifica o status de garantia de um produto utilizando o número de série. Use quando um cliente perguntar:
-
se o produto possui garantia;
-
quando a garantia expira;
-
qual tipo de cobertura está disponível.
Service Area Check
Ideal para empresas que atendem regiões específicas.
Nome do Tool
Service Area Check
Descrição
Verifica se existe cobertura de serviço ou entrega em determinada região utilizando CEP ou cidade do cliente.
Os Custom Tools funcionam melhor quando:
-
os dados de entrada são simples;
-
a API possui respostas previsíveis;
-
as informações são estruturadas;
-
o retorno é rápido e consistente.