Resumo
Webhooks no Chatbot Builder da Wati permitem que você envie e receba dados em tempo real entre seu chatbot e aplicativos externos usando solicitações de API GET ou POST. Esse recurso permite interações dinâmicas do chatbot, como buscar detalhes do usuário, verificar dados ou integrar com serviços de terceiros.
Observação: o recurso Webhook está disponível apenas nos planos Pro & Business. Se você estiver no plano Standard, poderá criar e salvar chatbots com webhooks, mas precisará fazer um upgrade para usá-los nos fluxos de trabalho Keyword Action ou Default Action.
Instruções
O Chatbot Builder Avançado está disponível apenas nos planos Pro & Business.
Como Usar Webhooks no Chatbot Builder
1. Adicionando um Webhook ao Seu Chatbot
Abra o Wati Chatbot Builder.
Arraste e solte o ícone Webhook no fluxo de trabalho do chatbot.
Conecte-o a uma etapa relevante do chatbot.
2. Configurando o Nó Webhook
URL & Método
Escolha um método de solicitação:
GETouPOST.Insira o URL de endpoint da API externa.
Torne o URL dinâmico inserindo variáveis usando o botão Variáveis.
Exemplo:https://webhook-wa-testing.clare.ai/123456789?name=##{{name}}![](https://brainfish-storage-prod.s3-accelerate.amazonaws.com/uploads/8e891fb2-b8da-40b6-8609-c45377c7118c/3e6b6f07-c5ff-4b63-b18f-b881dd533bdd/SCR-20250304-qcus.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20251203%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20251203T050551Z&X-Amz-Expires=3000&X-Amz-Signature=fadf7374dd24de3800f0d21096ec52e22c61a8ced2d283de071d936ae80ed172&X-Amz-SignedHeaders=host&response-content-disposition=attachment"=844x330")
Personalize os cabeçalhos
Os cabeçalhos permitem que você inclua detalhes extras em sua solicitação, como tipo de conteúdo ou autorização.
Os cabeçalhos são opcionais e estão desativados por padrão.
Eles devem seguir um formato chave-valor.
Exemplo:
Chave = Content-Type
Valor = application/json
Personalize o corpo
O corpo da solicitação é onde você inclui os dados enviados para a API externa.
O corpo é opcional e está desativado por padrão.
Quando habilitado, o corpo deve sempre estar no formato JSON.
Defina suas variáveis de teste
Defina manualmente as variáveis de teste para simular respostas da API ao configurar seu webhook.
3. Teste a solicitação do webhook
Clique em Testar a solicitação para verificar se a chamada da API funciona conforme o esperado.
4. Salve as respostas da API como variáveis
Você pode capturar valores da resposta da API e armazená-los em variáveis ou atributos personalizados.
Se a API retornar JSON com pares chave-valor, você pode extrair e salvar valores específicos.
Exemplo: armazenando "result": "success" de uma resposta da API:
{ "result": "success" }
Armazenando Valores Dentro de um Objeto
Use o formato:
objectKey.keyName.Exemplo: Para armazenar
QuoteIdda resposta abaixo, useResult.QuoteId.
{
"Result": {
"QuoteId": "xxxxx",
"QuoteNumber": "xxxxxx",
"PolicyNumber": null
},
"MessageValidation": null,
"QuoteReferrals": null
}Armazenar valores dentro de um array de objetos
Para extrair e armazenar um valor de um array de objetos, use o formato:
$.[0].objectKey.keyName[0].value
Exemplo: Para capturar o valor de current_status, use:
$.[0].tracking_data.shipment_track[0].current_status
JSON de exemplo:
[
{
"tracking_data": {
"track_status": 1,
"shipment_track": [
{
"id": 1278937320,
"current_status": "Entregue"
}
]
}
}
]
5. Usando Roteamento de Resposta
O roteamento de resposta permite que você divida as ações do chatbot com base nos códigos de status da resposta.
Você pode definir diferentes fluxos de chatbot dependendo da resposta da API.
Ao integrar Webhooks, você pode aprimorar a funcionalidade do chatbot com dados externos, automatizar fluxos de trabalho e melhorar as interações do usuário de forma dinâmica.
Perguntas Frequentes (FAQs)
Perguntas gerais
1. O que são webhooks no Chatbot Builder da Wati?
Webhooks permitem que seu chatbot envie ou receba dados em tempo real de aplicativos externos usando solicitações de API GET ou POST. Isso ajuda você a criar respostas de chatbot dinâmicas e personalizadas.
2. Quais planos oferecem suporte ao recurso de webhook?
Webhooks estão totalmente disponíveis nos planos Pro e Business. Os usuários do plano Standard podem criar e salvar chatbots com webhooks, mas precisam fazer um upgrade para usá-los nos fluxos de trabalho Keyword Action ou Default Action.
3. Como adiciono um webhook ao meu chatbot?
Abra o Chatbot Builder, arraste o ícone Webhook para o seu fluxo de trabalho e conecte-o à etapa do chatbot onde você deseja que a chamada da API aconteça.
4. Quais métodos e URLs posso usar para solicitações de webhook?
Você pode usar solicitações GET ou POST. Insira o endpoint da API necessário e insira variáveis no URL se quiser passar dados dinâmicos do usuário.
5. Os cabeçalhos e o corpo da solicitação são obrigatórios?
Não, ambos são opcionais. Adicione cabeçalhos apenas se a API precisar de detalhes extras, como autorização ou tipo de conteúdo. Habilite o corpo apenas quando precisar enviar dados JSON para a API externa.
Testes e tratamento de resposta
6. Como testo se meu webhook está funcionando?
Use a opção Testar a solicitação para confirmar se a chamada da API está funcionando conforme o esperado durante a configuração.
7. Posso armazenar valores da resposta da API?
Sim, você pode salvar os valores retornados em variáveis ou atributos personalizados. Isso funciona para respostas simples, objetos JSON aninhados e arrays.
8. Como extrair valores de objetos ou arrays aninhados?
Use a notação de ponto para objetos (por exemplo: Result.QuoteId) e o formato de array para listas (por exemplo: $.[0].tracking_data.shipment_track[0].current_status).
9. O que é o roteamento de resposta?
O roteamento de resposta permite que você defina diferentes fluxos de chatbot com base nos códigos de status da API, para que o chatbot possa responder de forma diferente a chamadas de API bem-sucedidas ou com falha.