Campanhas via Webhook

Leonardo Ebling Atualizado por Leonardo Ebling

Você pode configurar campanhas de disparo no WhatsApp usando Webhooks no Neoron Studio. Essa funcionalidade é ideal para enviar notificações automáticas sempre que um evento relevante ocorrer em seu sistema, como:

  • Atualização de status de entrega;
  • Cancelamento de agendamentos;
  • Mudanças em contratos ou pedidos;
  • Envio automático de pesquisas de satisfação (NPS).

Caso ainda não conheça o módulo Divulgar, recomendamos a leitura do artigo introdutório Noções Básicas do Módulo Divulgar.

Visão Geral da Campanha Webhook

  1. O usuário configura uma campanha do tipo Webhook no Neoron Studio.
  2. O seu sistema de gestão ou aplicação desenvolvida envia uma requisição para o webhook da campanha.
  3. O Neoron Studio processa os dados recebidos e dispara o template (mensagem) para o cliente via WhatsApp.

Criando uma Campanha Webhook

  1. Selecione "Webhook" como o método de segmentação
  1. (Opcional) Copie a URL (endpoint) do webhook da campanha.
    Após a criação da campanha, você poderá visualizar e copiar a URL do endpoint webhook gerado acessando a campanha sempre que quiser. Essa URL será usada para disparar as notificações posteriormente.
  2. Configure as variáveis do template
    As mensagens enviadas pela campanha podem conter variáveis dinâmicas (como nome, pedido, status etc.). Certifique-se de nomear as variáveis no template da mesma forma como serão enviadas no payload da requisição.
    Exemplo:
    • Template cadastrado no Neoron: "Olá {{nome}}, seu pedido {{pedido}} está a caminho!"
    • Variáveis enviadas no webhook: { "nome": "João", "pedido": "1234" }
  3. Defina se a notificação pode ser enviada para clientes em atendimento
    Configure se o disparo pode ser realizado para contatos que já possuem uma conversa ativa no Neoron Direct:
    • Não pode ser feito em atendimento: Se o cliente já estiver conversando com o chatbot ou um atendente, a campanha não será enviada.
    • Pode ser feito em atendimento: A mensagem será enviada dentro da conversa ativa do cliente.
  4. Finalize a criação da campanha
    Clique em "Finalizar" após revisar as configurações para finalizar a criação da campanha.

Como Enviar uma Campanha Webhook

  1. Encontre a URL (endpoint) da sua campanha
    Se ainda não copiou o endpoint, basta acessar a campanha e recuperar a URL.
  2. Verifique as variáveis do template
    Ao passar o cursor sobre o template cadastrado, as variáveis sublinhadas indicarão os nomes que devem ser informados na requisição para garantir que o envio ocorra corretamente.
  3. Localize a API Key do seu chatbot
    Acesse Criar > Personalizar > Chave de API e copie a sua API Key. Caso não tenha uma chave, clique em Gerar Chave.
    Só aperte em "Gerar chave" caso não tenha uma chave criada e em uso. Gerar uma nova API Key invalida a anterior e pode afetar outras integrações.
  4. Configure a requisição HTTP
    📌 Parâmetros da requisição:
    • Método: POST
    • Cabeçalho:
      • neoron_api_key: (sua API Key)
      • Content-Type: application/json
    • Corpo da requisição:
      {
      "phone_number": "5583988776655",
      "variables": {
      "nome": "Leonardo",
      "produto": "Televisão",
      "pedido": "5412"
      }
      }
    📌 Exemplo de requisição cURL:
    curl --location 'https://us-central1-neoron.cloudfunctions.net/api/campaigns/{{inserir hash da campanha}}' \
    --header 'neoron_api_key: {{inserir apikey}}' \
    --header 'Content-Type: application/json' \
    --data '{
    "phone_number": "5583988776655",
    "variables": {
    "nome": "Leonardo",
    "produto": "Televisão",
    "pedido": "5412"
    }
    }'
Baixe a collection de exemplo no Postman para facilitar os testes: Neoron Campaigns [Demo].postman_collection.json.

Orientações Gerais

Crie campanhas distintas para diferentes notificações

Exemplo: Separar campanhas para avisos de pagamento, confirmações de pedido e envio de NPS.

Alinhe as variáveis do template com o desenvolvedor

O nome das variáveis no template precisa ser idêntico ao informado no webhook.

Inclua variáveis complementares para personalizar o atendimento

Exemplo: Em uma campanha de boleto vencido, passe a URL do boleto como variável e configure um botão "Gerar segunda via" para redirecionar o cliente automaticamente.

Com essa configuração, você automatiza notificações importantes e melhora a experiência do seu cliente no WhatsApp! 🚀

Esse artigo te ajudou?

Noções básicas sobre o Divulgar

Suporte