Pular para o conteúdo
Português - Brasil
Portal do cliente Entrar
  • Não há sugestões porque o campo de pesquisa está em branco.

Configuração de Webhooks Personalizados (Integração)

Objetivo: Permitir que o administrador configure URLs de destino para receber notificações em tempo real (payloads) sempre que um evento específico (cadastro, login, etc.) ocorrer na plataforma.

Pré-Requisitos

  • Acesso de Administrador ao seu painel.

  • Ter o módulo de WEBHOOK ativado (add-on)

  • Ter a URL de Destino (Endpoint) do seu sistema/aplicação externa para onde os dados do webhook serão enviados (ex: uma API).

 

Ativação e Acesso à Configuração do Webhook

A área de configuração do Webhook é o local central para gerenciar suas integrações personalizadas.

  1. No menu lateral localize a opção > integração > API Webhook.

 

Configuração do webhook:

 

Atualmente possuímos 03 opções de configuração:

  • Cadastro
  • Login
  • Accounting

 

Selecione, na lista suspensa, o evento específico que deve acionar o envio do webhook :

 

 ⚠️ Importante: O payload (pacote de dados) enviado no webhook será diferente para cada tipo de evento selecionado. 

 

 

  • URL de Destino (Para onde enviar?): Insira a URL completa e válida (Endpoint) do seu sistema que receberá a requisição HTTP (POST) do webhook.

    • Exemplo: https://seu-servidor.com.br/api/receber-dados-mambo

  • Status/Ativo: Certifique-se de que a caixa de seleção esteja ATIVO para que o webhook comece a funcionar imediatamente.

 

Acompanhamento dos envios:

 

 

 Recomendações Gerais:

  1. Todas as requisições do webhook são enviadas via POST para o endereço da API cadastrado em cada um dos eventos.

  2. Cada evento pode possuir uma chave e valor específico para ser enviado junto com cada POST para a API do cliente. Sendo um método seguro de informar um token para uma validação, assegurando que o eventos enviados no endpoint da API, estão partindo de nossa plataforma ou também pode ser um Token de autenticação na API de destino.

  3. A URL da API aceita parâmetros, sendo possível customizar ela com dados específicos caso o cliente deseje. Exemplo de URL no evento de Login: https://api.exemplo.com/v1/login?source=mambo-wifi&portal=farmacia3.mambowifi.com&evento=login  . Sendo estes, parâmetros da escolha do cliente.

  4. O Webhook não injeta parâmetros na URL. Todo o dado é enviado no corpo do JSON

  5. Podem ser utilizados dados diferentes em cada URL de cada evento, assim como chaves e parâmetros diferentes no header.

  6. Cada evento do Webhook pode ser ativado e desativado individualmente, sem afetar o funcionamento dos demais.

  7. Em caso de falha no envio, o Webhook tenta enviar o evento novamente a cada 6 horas. Após exceder o limite de tentativas, o evento é descartado.

  8. Ao concluir o envio ou falha do evento, o Webhook adiciona dados de contabilização nos gráficos abaixo.

  9. Os eventos pendentes, podem ser visualizados na tabela de tarefas pendentes, abaixo.

  10. Ao ativar o envio de Accountings, enviamos todos os eventos de Start e Stop para Accounting. (Se ativado, este recurso irá gerar um volume considerável de eventos para o endpoint informado. Certifique-se de que sua aplicação está preparada para este volume de dados.)

  11. O evento de Login é registrado sempre que um visitante informa as credenciais e efetua Login com sucesso ou quando ele retorna a rede e clica em Conectar, através do reconhecimento automático de visitantes, no Login com 1 Click.

  12. O evento de cadastro é disparado sempre que um novo cadastro é efetuado com sucesso.

  13. Certifique-se de liberar os IP's 144.22.166.76 e 144.22.197.135  na regra de entrada do firewall, para receber as requisições do nosso webhook.

  14. Uma vez que um evento é incluído na fila de execução, ele é executado até atingir o limite de falhas nas tentativas ou atingir sucesso na execução. Os envios não podem ser cancelados. As tentativas podem ocorrer até 72 horas após a criação do evento..