O que é um webhook?

Os webhooks são um método pelo qual os servidores da Botmaker se comunicam com os servidores do cliente quando determinados eventos ocorrem. Por exemplo, quando um bot envia uma mensagem, é disparada uma notificação de webhook. Dessa forma, os clientes podem integrar esses eventos com um sistema para, por exemplo, coletar todas as mensagens enviadas por um bot. Nota: Lembre-se que, para usar essa funcionalidade, você deve ter um papel de superadministrador ou um papel com permissão para a tela de webhooks.

Integrar webhooks na Botmaker

Para acessar a tela de webhooks, vá em Menu > Integrações > Webhooks.

Dentro da tela de webhooks na Botmaker, você pode:

• Criar, editar e excluir webhooks.
• Conectar webhooks aos canais de sua preferência.
• Configurar quais tipos de mensagens você deseja que sejam notificadas.
• Receber notificações sobre mudanças de variáveis.
• Testar webhooks: com ferramentas para que você possa verificar se detectam e processam corretamente as diferentes notificações.

Como criar um webhook?

Para criar um novo webhook, basta clicar em Novo webhook. Abrirá uma janela pop-up onde você terá que preencher todos os campos.

Pronto! Seu webhook foi criado. Nota: Você pode ter múltiplos webhooks. No entanto, não é possível ter mais de um webhook para o mesmo canal.

O que você encontrará em cada webhook?

Botões na barra azul superior:

• Ligar ou desligar este webhook
• Editar
• Excluir

Test webhook: por aqui você pode testar a mensagem que o webhook irá enviar, conforme sua configuração. Lembre de deixar o webhook ativado, caso contrário, esta opção não funcionará.

Error logs: aqui você tem mais detalhes sobre os últimos erros.

No histograma, é possível ver a quantidade de:

• Respostas bem-sucedidas
• Respostas lentas
• Respostas com erro
• Respostas rejeitadas, envio de mensagens bloqueado devido a repetidas falhas no webhook

Nos últimos 30 minutos, você encontrará:

• Tempo mais rápido
• Tempo médio
• Tempo mais lento

Dessa forma, você poderá checar o estado de saúde do seu servidor. Se o webhook falhar mais de 100 vezes durante 10 minutos, novas mensagens deixarão de ser enviadas pelos próximos 10 minutos para evitar sobrecarregar o servidor (essas mensagens serão perdidas). Por isso, é importante manter a operacionalidade do cluster de servidores que receberá as mensagens do webhook.

Nota: Esta funcionalidade não está ativa por padrão, pois tem um custo adicional. Para ativá-la, vá à seção "Conta". Lá você encontrará um campo específico com o título "webhook", de onde poderá ativar a funcionalidade com apenas um clique.

Tipos de webhook

Existem 3 tipos principais de webhooks:

• Mensagens (Bots, Agentes, Usuários)
• Estados (mensagens, modelos WA)
• Eventos

São diferenciados pelo campo type.

No artigo a seguir, detalharemos os formatos para os diferentes tipos de mensagens que você receberá no seu webhook. https://help.botmaker.com/pt/help/5976723636536441591