[Extensão] Como criar webhooks na Blip para enviar dados do bot a sistemas externos

1. Introdução

2. Funcionalidades

3. Instalação

4. Como criar e configurar um webhook

5. Exemplos de uso

6. Dicas

7. Suporte

Descrição breve: Crie webhooks personalizados na Blip para enviar contatos, mensagens e eventos do seu chatbot automaticamente a CRMs, planilhas e outros sistemas externos via HTTP.

Introdução

A extensão Webhook Manager cria webhooks personalizados na Blip para enviar dados do seu bot automaticamente a sistemas externos. Sempre que um contato é atualizado, uma mensagem trafega na conversa ou um evento é registrado, a extensão dispara uma requisição HTTP para a URL que você definir, com o conteúdo no formato que o sistema de destino espera.

Por exemplo, você pode enviar cada novo contato do WhatsApp para o seu CRM assim que ele aparece na conversa, e a base externa fica sincronizada sem trabalho manual. A URL e o corpo da requisição aceitam Liquid, então você monta o payload com os campos do contato, da mensagem ou do evento.

Funcionalidades

• Criação de vários webhooks, cada um com sua própria configuração.

• Três tipos de envio: contatos, mensagens e eventos (event tracking) da conversa.

• Métodos HTTP POST, PUT e PATCH.

• Cabeçalhos personalizados para autenticação, como token ou API key.

• URL e corpo dinâmicos com Liquid, usando campos do contato, da mensagem ou do evento.

• Opção de não enviar a requisição quando o corpo renderizado fica vazio.

• Edição e exclusão dos webhooks já cadastrados.

Suportada nos seguintes canais: todos os canais disponíveis na plataforma Blip.

Nota: o Webhook Manager envia os dados em uma única via. A resposta da API externa não retorna para o fluxo do bot.

Instalação

Atenção: esta é uma extensão paga, desenvolvida pela Wiv.

1. Acesse a Webhook Manager na Blip Store e ative a extensão.

2. Instale a extensão no Roteador ou no bot que processa os canais usados na sua operação. A extensão passa a receber os contatos, mensagens e eventos desse bot.

3. Abra o bot onde instalou a extensão, clique nos três pontos no canto superior direito e selecione Webhook Manager. A tela de gerenciamento dos webhooks cadastrados abre.

Nessa tela você cria novos webhooks, edita configurações existentes ou exclui os que não usa mais.

Como criar e configurar um webhook

Clique em Criar novo webhook. A tela de configuração abre com um webhook padrão, pronto para você ajustar.

Configure os campos a seguir:

Tipos de envio

Selecione quais informações o webhook envia. Você pode marcar um ou mais tipos:

• Contato: dados do contato, como identity, nome, e-mail, telefone e campos extras.

• Mensagem: dados da mensagem, como id, tipo, remetente, destinatário, conteúdo e metadados.

• Eventos: dados de event tracking, como identity, categoria, ação e campos extras.

URL

No campo URL, informe o endpoint que recebe os dados, fornecido pelo sistema externo. O campo aceita Liquid, então você pode montar URLs dinâmicas com base em campos do contato ou da conversa. Por exemplo:

Método

Em Método, selecione o método HTTP da requisição: POST, PUT ou PATCH. Siga a documentação do sistema de destino. Em geral, use POST para criar um registro, PUT para substituir um registro inteiro e PATCH para atualizar parte de um registro.

Cabeçalho

Use o cabeçalho para enviar dados de autenticação ou identificação, como um token ou uma API key. Clique em Adicionar nova chave no cabeçalho e preencha a chave e o valor. As chaves do cabeçalho aceitam apenas letras, hífen e sublinhado. Um exemplo comum:

Corpo da requisição

No campo Corpo, defina o conteúdo enviado para a URL. O corpo aceita Liquid, o que permite inserir variáveis, campos do contato e lógica condicional. Estão disponíveis três objetos, conforme o tipo de envio: contact, message e tracking. Por exemplo, para enviar dados de um contato:

Marque a opção Caso o corpo esteja vazio, não realizar a requisição quando o corpo depender de alguma condição. Se a lógica resultar em um corpo vazio, a extensão não envia a requisição e evita chamadas desnecessárias ao sistema externo.

Depois de preencher os campos, clique em Salvar webhook.

O webhook salvo aparece na lista de webhooks cadastrados, onde você pode editá-lo ou excluí-lo quando precisar. A partir daí, ele já envia as informações da Blip para o sistema externo definido.

Exemplos de uso

Um uso comum do Webhook Manager é integrar o bot a um CRM ou a uma base externa de contatos, como HubSpot, RD Station, Salesforce, Airtable ou uma planilha.

Para cadastrar novos contatos, crie um webhook do tipo Contato, informe a URL da API de destino, escolha o método POST e monte o corpo com os campos necessários: Assim, sempre que um contato for identificado, os dados seguem automaticamente para o sistema externo.

Para atualizar contatos existentes, use o método PUT ou PATCH, conforme a API de destino, e envie os campos que mudam. Esse tipo de configuração mantém o sistema externo atualizado com as informações mais recentes do contato na Blip.

Dicas

• Teste a URL de destino com uma ferramenta como webhook.site antes de usar em produção, para conferir o formato que chega ao sistema externo.

• Configure primeiro em um bot de homologação e, depois de validar o comportamento, replique no bot de produção.

• Confira se os campos usados no Liquid existem no contato ou no contexto da conversa. Variáveis inexistentes geram envios incompletos.

• Confirme com a documentação da API de destino qual método usar e quais cabeçalhos de autenticação enviar.

Suporte

Em caso de dúvidas na configuração ou de problemas na extensão, fale com o time de suporte da Wiv pelo e-mail support@wiv.com.br.

Precisa de mais ajuda? Explore nossos conteúdos na Blip Academy ou Blip Community, assista a tutoriais no nosso canal do YouTube ou tire suas dúvidas em nosso canal de atendimento 😃