> ## Documentation Index
> Fetch the complete documentation index at: https://docs.saninternet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notificações

> Decide quais avisos o painel manda quando algo acontece no servidor, para quem manda, e se além do e-mail ele avisa também um sistema de fora, por webhook.

**Caminho no painel:** menu da esquerda > Configuração > cartão **Painel de
Controle** > **Notificações**

![Tela de Notificações: os botões do topo e a tabela do grupo Gerenciamento de conta](https://mintcdn.com/san-internet/dZE3NBY61yDby7Jw/keyhelp-admin/imagens/controle-notificacoes.png?fit=max\&auto=format\&n=dZE3NBY61yDby7Jw\&q=85\&s=66fe9f350a18718bebed9c1bd5c75e68)

## Os 25 eventos, em cinco grupos

| Grupo | Eventos | Vai para |
| - | - | - |
| **Gerenciamento de conta** | 8 | cliente, com três exceções abaixo |
| **Utilização de recursos** | 7 | cliente, menos o estouro de tráfego |
| **Domínios** | 3 | cliente, menos o problema de SSL/TLS |
| **Backup** | 3 | cliente e administrador |
| **Servidor** | 4 | administrador |

A coluna **DESTINATÁRIOS** tem dois ícones, e o mouse parado em cima diz qual é
qual: **Contas de clientes** e **Contas de administrador**. O ícone fica apagado
quando aquele tipo de conta **não** recebe o aviso.

**Conferido, ícone por ícone**, quem recebe o quê:

| Vai para | Eventos |
| - | - |
| **Cliente e administrador** | login bem-sucedido; senha esquecida; problema de SSL/TLS; os três de backup |
| **Administrador** | cliente atualizou dados de contato; cliente estourou o tráfego do mês; problema de licença; verificação de antivírus; painel atualizado; fila de e-mail acima do limite |
| **Cliente** | os outros 13, que são criação de conta, novas credenciais, conta de e-mail criada, conta suspensa, conta reativada, os seis avisos de 90% e 100% de disco, arquivos e caixa postal, e domínio ativado ou desativado |

**Todos vêm ligados de fábrica.**

**"Administrador" quer dizer todas as contas de administrador.** Medido com o
estouro de tráfego de um cliente: o aviso foi para as quatro contas de
administrador do servidor, cada uma no e-mail da própria ficha, e saiu quando a
tarefa **Atualizar estatísticas** rodou. **Sai uma vez por conta, por mês:** na
execução seguinte, com a conta ainda acima do limite, nenhum e-mail saiu. Ver
[Estatísticas de Tráfego](/keyhelp-admin/estatisticas-de-trafego).

## Mexer em um evento

O lápis da linha abre uma janela com dois ajustes.

![Janela de configuração de um evento, com a chave Está ativado e o campo Enviar cópia](https://mintcdn.com/san-internet/dZE3NBY61yDby7Jw/keyhelp-admin/imagens/controle-notificacoes-editar.png?fit=max\&auto=format\&n=dZE3NBY61yDby7Jw\&q=85\&s=29f552bd5defbd19248974dacefbfc42)

| Campo | O que faz |
| - | - |
| **Está ativado** | desmarcado, o aviso deixa de ser enviado quando o evento acontece |
| **Enviar cópia** | um ou mais endereços, separados por vírgula, que recebem cópia do aviso |

Clique em **Salvar**. A linha passa a mostrar o novo estado e o endereço de cópia.

> [!NOTE]
>
> **O painel guarda no banco só o que você mudou**
>
> Medido: com os 25 eventos no padrão, a tabela de notificações do painel está
> **vazia**. Ao desligar um evento e pôr uma cópia, apareceu **uma linha**, a dele.
> Ao redefinir, a linha sumiu e a tabela voltou a ficar vazia.
>
> Na prática isso é bom: o padrão de fábrica não é uma cópia congelada no banco,
> é a ausência de exceção. Atualização do painel que mude um padrão passa a valer
> para todo evento que você nunca tocou.

## Voltar ao padrão

Três caminhos, e todos pedem confirmação:

1. A **seta de redefinir** na linha, que aparece **somente nas linhas que você mudou**.
2. **Ações em massa > Redefinir seleção**, com as caixas da esquerda marcadas.
3. **Redefinir todas as configurações**, no alto.

**Conferido:** redefinir um evento apaga a linha dele no banco e o painel registra
no histórico que as configurações de notificação foram redefinidas.

## Configurações gerais

O botão **Configurações gerais**, no alto da tela, abre os ajustes que valem para
todos os avisos.

![Tela de configurações gerais: nome e e-mail do remetente, SMTP externo, URL do webhook e idioma prioritário](https://mintcdn.com/san-internet/dZE3NBY61yDby7Jw/keyhelp-admin/imagens/controle-notificacoes-gerais.png?fit=max\&auto=format\&n=dZE3NBY61yDby7Jw\&q=85\&s=670177926d1f0c45507bc259c4406ea7)

| Campo | O que faz |
| - | - |
| **Nome do remetente** | vazio usa o nome padrão do painel |
| **Endereço de e-mail do remetente** | de quem os avisos saem. Vem preenchido com o endereço de sistema do servidor |
| **Usar servidor de SMTP externo** | manda os avisos por outro servidor de e-mail, em vez do próprio |
| **URL do webhook** | endereço que recebe os dados de cada evento |
| **Idioma prioritário** | força um idioma para todos, em vez do idioma do perfil de cada usuário |

A tela avisa que o servidor precisa estar autorizado a enviar em nome do endereço
de remetente escolhido, ou os avisos podem ser recusados ou cair no spam. Quem
cuida disso é o SPF do domínio, no [Editor de DNS](/keyhelp-admin/editor-de-dns).

Sobre o idioma: uma mensagem personalizada que exista no idioma do perfil do
usuário é sempre usada, mesmo com idioma prioritário definido.

## O webhook, medido de ponta a ponta

Com um receptor de teste rodando no próprio servidor, o clique em **Testar
webhook** entregou isto:

| O que | Valor medido |
| - | - |
| Método | **POST** |
| Formato | **`multipart/form-data`**, e não JSON |
| Identificação de quem chama | `KeyHelp/26.1.1 (https://www.keyhelp.de) PHP/8.4.24 curl/8.14.1` |
| Campos enviados | `id_user`, `username`, `email`, `language`, `event`, `subject`, `message` |

> [!WARNING]
>
> **O webhook manda formulário, e não JSON**
>
> A maioria dos serviços que recebem webhook hoje espera JSON. Este manda
> `multipart/form-data`, que é o formato de um formulário com anexo. Quem for
> ligar isso a um sistema de fora provavelmente vai precisar de um tradutor no
> meio, e é bom saber disso antes de prometer a integração.

> [!WARNING]
>
> **O botão Testar webhook não diz se deu certo**
>
> Medido duas vezes: com um receptor no ar e com uma porta sem ninguém ouvindo, o
> painel **não mostrou mensagem nenhuma** nos dois casos. A requisição saiu de
> verdade na primeira, e nada na tela distingue uma da outra.
>
> A única forma de confirmar é olhar do lado de quem recebe.

**O teste não salva o campo.** Conferido: depois de escrever a URL e clicar em
**Testar webhook**, o valor no banco continuou vazio. Para o webhook valer nos
eventos de verdade, é preciso clicar em **Salvar**.

## Mensagens personalizadas

**Adicionar mensagem customizada** cria um texto próprio para um evento, em um
idioma.

![Formulário de mensagem personalizada, com evento, idioma, os espaços reservados, assunto, texto e o envio de teste](https://mintcdn.com/san-internet/dZE3NBY61yDby7Jw/keyhelp-admin/imagens/controle-notificacoes-mensagem.png?fit=max\&auto=format\&n=dZE3NBY61yDby7Jw\&q=85\&s=035e3b20d26f5476cb678e53a837bf6b)

1. Escolha o **Evento**.
2. Escolha o **Idioma**.
3. **Carregar mensagem padrão** traz o texto de fábrica para você editar em cima.
4. Escreva o **Assunto** e o **Texto**.
5. Em **Mensagem de teste de e-mail**, escreva um endereço e clique em **Enviar e-mail** para ver o resultado.
6. Clique em **Salvar**.

O campo **Mensagem de teste de e-mail** vem preenchido com o e-mail do
administrador logado.

> [!NOTE]
>
> **O e-mail de teste não troca os espaços reservados do cliente**
>
> Medido com o evento de conta criada: a mensagem de teste chegou com
> `##full_name##`, `##username##` e `##password##` escritos assim, sem troca. O
> assunto, o resto do texto e o [design do e-mail](/keyhelp-admin/modelos-de-design-de-e-mail)
> vieram normais.

### Os espaços reservados

São marcadores no formato `##nome##`, trocados pelo valor real no envio.

**Medido: a lista muda conforme o evento escolhido.** Sem evento escolhido a tela
mostra oito, que valem para qualquer aviso. Ao escolher um evento, entram os dele.

| Sempre disponíveis | O que vira |
| - | - |
| `##username##` | o nome de usuário de quem recebe |
| `##first_name##`, `##last_name##`, `##full_name##` | nome, sobrenome e os dois juntos, com o nome de usuário como reserva |
| `##company##` | a empresa de quem recebe |
| `##panel_url##` | o endereço do painel |
| `##server##` | o nome do servidor |
| `##date_time##` | a data e a hora do envio |

| Do evento escolhido | Aparece em |
| - | - |
| `##password##`, `##reset_link##` | criação de conta, novas credenciais e senha esquecida |
| `##email##`, `##mailbox##` | conta de e-mail criada e limite de caixa postal |
| `##domain##` | domínio ativado ou desativado |
| `##backup_status_short##`, `##backup_status_long##`, `##backup_message##`, `##backup_type##`, `##repository##` | os eventos de backup |
| `##certificate_messages##` | problema de SSL/TLS |
| `##version##`, `##update_notes##`, `##changelog_url##` | painel atualizado |
| `##client_username##`, `##traffic_usage##`, `##traffic_limit##` | estouro de tráfego |
| `##license_problems##` | problema de licença |

> [!WARNING]
>
> **`##password##` põe a senha da conta dentro do e-mail**
>
> O marcador existe e funciona, e e-mail comum trafega e fica guardado sem
> proteção na caixa de quem recebe, muitas vezes por anos. Preferir
> `##reset_link##`, que manda um link para a pessoa definir a senha, deixa a senha
> fora do e-mail.

## O que pode dar errado

| Sintoma | Causa | O que fazer |
| - | - | - |
| **O cliente não recebe nenhum aviso** | o evento está desligado, ou o e-mail está sendo recusado por falta de autorização de envio | conferir a coluna **ESTÁ ATIVADO** e o SPF do domínio do remetente |
| **Liguei o webhook e nada chega** | o campo não foi salvo, ou a URL não responde | clicar em **Salvar**, e conferir do lado de quem recebe, porque o teste não avisa |
| O sistema que recebe o webhook não entende os dados | ele espera JSON, e o painel manda `multipart/form-data` | tratar o formato de formulário no receptor |
| **Mudei um padrão e quero voltar atrás, mas não lembro qual** | a seta de redefinir só aparece nas linhas alteradas | procurar as linhas com a seta, ou usar **Redefinir todas as configurações** |
| O aviso chega em inglês para um cliente brasileiro | há idioma prioritário definido, ou o perfil do usuário está em outro idioma | conferir **Idioma prioritário** em **Configurações gerais** |
| A mensagem personalizada não aparece | ela vale para um evento e um idioma por vez | criar também no idioma do perfil de quem recebe |

## Ver também

* [Certificados SSL/TLS](/keyhelp-admin/config-certificados-ssl-tls), que tem avisos próprios, citados no alto desta tela
* [Backup](/keyhelp-admin/backup), origem de três dos eventos. O aviso *"Uma operação de backup foi concluída"* é o que [Criar um backup](/keyhelp-admin/criar-backup) manda para o endereço escolhido no formulário
* [Gerenciamento da Licença](/keyhelp-admin/gerenciamento-da-licenca), origem do evento de problema de licença
* [Servidor de E-mail](/keyhelp-admin/servidor-de-email), onde fica o limite da fila que dispara um dos avisos
* [Editor de DNS](/keyhelp-admin/editor-de-dns), onde se autoriza o servidor a enviar pelo domínio


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.