Resumo

Webhooks no Construtor de Chatbot da Wati permitem enviar e receber dados em tempo real entre seu chatbot e aplicações externas usando requisições de API GET ou POST. Este recurso possibilita 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 Nó de Webhook do Chatbot está disponível apenas nos planos Pro e Business.

Instruções

Como Usar Webhooks no Construtor de Chatbot

1. Adicionando um Webhook ao Seu Chatbot

Abra o Construtor de Chatbot da Wati.
Arraste e solte o ícone Webhook no fluxo do chatbot.
Conecte-o a uma etapa relevante do chatbot.

2. Configurando o Nó de Webhook

URL e Método

Escolha um método de requisição: GET ou POST.
Insira o endpoint de URL da API externa.
Torne a URL dinâmica inserindo variáveis usando o botão Variáveis.

Exemplo:
```
https://webhook-wa-testing.clare.ai/123456789?name={{name}}
```

Personalizar cabeçalhos

Os cabeçalhos permitem incluir detalhes extras na sua requisição, como tipo de conteúdo ou autorização.
Os cabeçalhos são opcionais e desativados por padrão.
Eles devem seguir um formato de chave-valor.

Exemplo:

Chave = Content-Type
Valor = application/json

Personalizar o corpo

O corpo da requisição é onde você inclui os dados enviados para a API externa.
O corpo é opcional e desativado por padrão.
Quando ativado, o corpo deve sempre estar em formato JSON.

Definir suas variáveis de teste

Defina variáveis de teste manualmente para simular respostas da API enquanto configura seu webhook.

3. Testar a requisição do webhook

Clique em Testar a requisição para verificar se a chamada da API funciona como esperado.

4. Salvar 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: armazenar "result": "success" de uma resposta de API:

{   "result": "success" }

Armazenando Valores Dentro de um Objeto

Use o formato: chaveDeObjeto.nomeDaChave.
Exemplo: Para armazenar QuoteId da resposta abaixo, use Result.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].chaveDeObjeto.nomeDaChave[0].valor
```
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": "Delivered"
        }
      ]
    }
  }
]

5. Usando Roteamento de Resposta

O roteamento de resposta permite dividir 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 dinamicamente.

Perguntas Frequentes (FAQs)

Perguntas gerais

1. O que são webhooks no Construtor de Chatbot da Wati?

Webhooks permitem que seu chatbot envie ou receba dados em tempo real de aplicações externas usando requisições de API GET ou POST. Isso ajuda você a criar respostas de chatbot dinâmicas e personalizadas.

2. Quais planos suportam o recurso de webhook?

Webhooks estão totalmente disponíveis nos planos Pro e Business.

3. Como adiciono um webhook ao meu chatbot?

Abra o Construtor de Chatbot, arraste o ícone Webhook para o seu fluxo e conecte-o à etapa do chatbot onde você deseja que a chamada de API ocorra.

4. Quais métodos e URLs posso usar para requisições de webhook?

Você pode usar requisições GET ou POST. Insira o endpoint de API necessário e insira variáveis na URL se desejar passar dados dinâmicos do usuário.

5. Cabeçalhos e corpo da requisiçã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. Ative o corpo apenas quando você precisar enviar dados JSON para a API externa.

Testando e tratando respostas

6. Como eu testo se meu webhook está funcionando?

Use a opção Testar a requisição para confirmar que a chamada da API está funcionando como esperado durante a configuração.

7. Posso armazenar valores da resposta da API?

Sim, você pode salvar valores retornados em variáveis ou atributos personalizados. Isso funciona para respostas simples, objetos JSON aninhados e arrays.

8. Como extraio valores de objetos ou arrays aninhados?

Use 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 é roteamento de resposta?

O roteamento de resposta permite que você defina diferentes fluxos de chatbot com base em códigos de status da API, para que o chatbot possa responder de forma diferente a chamadas de API bem-sucedidas ou falhas.

Como usar webhooks no Wati's Chatbot Builder