Configuracao Inicial
Conectado por sessão segura.
Configuracao
Conectado por sessão segura. O token da API fica no servidor — você não precisa informá-lo. Use o botão "Sair" na barra lateral para encerrar a sessão.
Passo 2 — Configurar Canal
Cadastro independente. Registra a credencial de envio (ex.: WhatsApp Phone ID + Token). Um canal só é usado quando uma Rota (Passo 6) o seleciona.
Canal e a credencial de envio (API URL, token, SMTP, webhook, etc). Evento e template definem o conteudo; canal define como enviar em cada plataforma.
Configuracao de Canal
Escolha o tipo de canal para exibir apenas os campos daquela plataforma. WhatsApp segue o padrao existente (API URL + Token + Phone ID).
Canais cadastrados
POST cria o canal em segundo plano. Use "Atualizar lista" para recarregar. Selecione um canal para carregar seus dados no formulario.
Clique em "Atualizar lista" para carregar.
Passo 1 — Cadastrar Contato
Cadastro independente. Aqui você só registra pessoas (nome + canais como WhatsApp/e-mail). Um contato só recebe alertas quando entra numa Rota (Passo 6) — direto ou via Grupo (Passo 3).
Contato pode ser geral (sem evento) ou especifico para um evento.
Contato
Voce pode cadastrar com apenas 1 canal agora (ex.: WhatsApp) e complementar depois (email/telegram/teams) usando o mesmo contato (ID opcional ou mesmo nome).
Contatos cadastrados
O ID é gerado automaticamente no cadastro. Use os botões para editar ou excluir.
Clique em "Atualizar lista" para carregar.
Passo 3 — Criar Grupo (Opcional)
Opcional e independente. Junta contatos (Passo 1) para reuso. Um grupo só dispara alertas quando é ligado a uma Rota (Passo 6). Adicionar um contato a um grupo que já está numa rota faz ele passar a receber automaticamente.
Grupo e opcional: voce pode rotear para grupo ou para contatos individuais.
Grupo de Contatos
Grupos cadastrados
Use "Atualizar lista" para recarregar. Clique em "Ver contatos" para listar os membros de um grupo.
Clique em "Atualizar lista" para carregar.
Adicionar Contato ao Grupo
Passo 4 — Cadastrar Template
Cadastro independente. Define o formato/conteúdo da mensagem por tipo de canal. Só é usado quando uma Rota (Passo 6) o escolhe.
Templates podem ser globais; no Meta WhatsApp, use o preset.
Template
Templates cadastrados
Lista carregada de GET /api/templates. Clique em "Usar" para carregar os dados no formulario.
Clique em "Atualizar lista" para carregar.
Templates existentes (somente leitura)
Lista para referência; para usar em rota, selecione na aba Rota.
Passo 5 — Cadastrar Evento
Cadastro independente. Define o gatilho (ex.: VM_ALARM). Só gera envio quando existe uma Rota (Passo 6) ligada a ele.
Evento define o event_type (codigo) e os fields.
Evento (Cadastro)
Eventos cadastrados
Lista carregada de GET /api/events. Use os botoes para editar ou excluir.
Clique em "Atualizar lista" para carregar.
Eventos existentes (somente leitura)
Lista para referência; para usar em rota, selecione na aba Rota.
Passo 6 — Criar Rota
🔗 É aqui que tudo se conecta. A Rota junta Evento (Passo 5) + Template (Passo 4) + Canal (Passo 2) + Destinatários (Contato do Passo 1 ou Grupo do Passo 3). Por isso, para criar a Rota, esses itens já precisam estar cadastrados. Sem Rota, nada é enviado — os outros passos sozinhos não disparam nada.
Rota liga evento + template + canal e define destino.
Rota
Rotas cadastradas
Use "Listar Rotas" para carregar. Os tokens só aparecem uma vez, no cartão de criação.
Clique em "Listar Rotas" para carregar.
Rotas Cadastradas e Exemplos
Selecione uma rota para ver exemplos.
Passo 7 — Enviar Evento de Teste
Dispara um evento de teste em uma Rota existente para validar o caminho ponta a ponta. Depois, confira na aba Resumo quem está configurado para receber.
Evento (Envio) — teste interno (admin)
Este envio e o teste interno do admin: passa pelo proxy same-origin (POST /api/events/send) e nao usa token. Para o cliente integrar por conta propria, use o cartao "Integracao do cliente (externo)" abaixo.
Integracao do cliente (externo)
Exemplo pronto para o cliente enviar eventos direto na API publica (endpoint /external/routes/:id/events). Este endpoint nao passa pelo proxy do admin e exige o token da rota — por isso e apenas um trecho copiavel, nao e executado aqui.
E a URL da API (ex.: https://apinotify.seu-dominio), NAO a do admin. Ajuste se necessario.
Este botao usa o proxy do admin (mesma origem). O cliente real chama a URL publica da API diretamente.
Entregue ao cliente exatamente: (1) a URL do endpoint (<URL publica>/external/routes/<id>/events), (2) o route_token, (3) o corpo JSON (os campos de data sao os fields do evento). O client_token tambem funciona no header Authorization: Bearer.
Dead-letter (falhas)
Lista de GET /api/event-processing-logs. Clique em "Ver" para preencher o campo de busca por ID abaixo.
Clique em "Listar Dead Letters" para carregar.
Dead Letter
Últimos envios
Últimos registros de envio (GET /api/notification-logs). O destino já vem mascarado pelo servidor.
Clique em "Atualizar" para carregar.
Resumo — Quem recebe o quê e por onde
Visão consolidada de todas as rotas: o evento que dispara, o template que formata, o canal por onde sai e os destinatários finais já resolvidos (mesma lógica do envio, com número mascarado). Use para conferir se cada alerta chega em quem deve.
Clique em "Atualizar resumo" para carregar.
Passo 8 — Cache
Operacoes de Cache
Clique em uma operacao de cache para ver o resultado aqui.
Admin — Tokens de Clientes
Visualize todos os client_id e regenere token rapidamente quando houver vazamento/ataque.
Gestao Geral
Pagina 1 de 1