Um webhook posta uma mensagem curta em um canal do Discord quando algo acontece no seu servidor: ele inicia, para ou cai, um jogador entra ou sai, ou um backup termina. Todos no canal veem a mensagem sem abrir o painel. Um webhook também pode enviar para qualquer outro endereço https, para suas próprias ferramentas.
Só o dono de um servidor pode configurar os webhooks dele. As pessoas que você convidou para o servidor não veem a página.
1. Crie um webhook no Discord
Você precisa de permissão para gerenciar webhooks no servidor do Discord. O dono e os admins dele normalmente têm essa permissão.
- No Discord, abra Configurações do servidor e vá em Integrações.
- Clique em Criar webhook, dê um nome a ele e escolha o canal de texto onde ele posta, por exemplo um canal
#server-alerts. - Clique em Copiar URL do webhook.
O Discord explica esses passos com imagens no guia Intro to Webhooks (em inglês). Trate a URL do webhook como uma senha: quem tiver essa URL pode postar no canal.
2. Adicione ao seu servidor
- Abra seu servidor no painel e clique em Webhooks no menu da esquerda.
- Clique em Adicionar um, ou em Novo webhook se o servidor já tiver um.
- Dê um Nome a ele, se quiser. Ele serve só para você e identifica o webhook na sua lista.
- Cole o endereço em URL. Ele precisa começar com
https://. Quando é um webhook do Discord, o painel mostra Webhook do Discord reconhecido. - Em Enviar quando, marque os eventos que você quer (veja abaixo). Servidor caiu já vem marcado, e pelo menos um evento precisa estar marcado.
- Clique em Criar webhook.
Os eventos
| Evento | Quando é enviado |
|---|---|
| Servidor iniciado | Quando o servidor está no ar e pronto para os jogadores, inclusive depois de um reinício. |
| Servidor parado | Uma parada que alguém pediu: você, um membro da equipe ou um agendamento. |
| Servidor caiu | O servidor caiu sem que ninguém pedisse. É enviado um ou dois minutos depois, quando temos certeza, e diz se o servidor voltou sozinho. |
| Jogador entrou | Com o nome do jogador, nos jogos que informam quem está online. Os jogos que informam só uma contagem dizem quantos são. |
| Jogador saiu | O mesmo, quando alguém sai. Os jogadores são verificados uma vez por minuto enquanto o servidor está ligado. |
| Backup concluído | Se o backup deu certo e qual o tamanho dele. |
| Instalação concluída | Depois da primeira instalação ou de uma reinstalação. |
| Transferência concluída | Quando a mudança do seu servidor termina. |
Os servidores de Project Zomboid têm eventos extras lidos do log do jogo: Jogador morreu, Morte em PvP, Ação de admin, Mod atualizado, Contagem do reinício iniciada e Repassar o chat do jogo. O chat só é enviado se você marcar essa opção, e só o chat geral: sussurros e chats de facção e de safehouse nunca são enviados.
O que chega
- No Discord, as mensagens chegam da PlayNHost como cards curtos com o nome do servidor, o que aconteceu e quando. O Discord mostra a hora no fuso horário de cada leitor.
- As mensagens citam o nome do seu servidor, mas nunca incluem o endereço nem o ID dele, então podem ir para um canal público. Para mudar o nome que elas mostram, renomeie o servidor. Veja Como renomear seu servidor e mudar os slots de jogadores.
- Um jogador não consegue marcar seu canal com o nome dele. Um nome como
@everyonechega como texto simples. - Qualquer outro endereço recebe os eventos como JSON. Veja Para suas próprias ferramentas abaixo.
Desligue um webhook, mude-o ou exclua-o
- Use o interruptor na linha de um webhook para desligá-lo e ligá-lo de novo. Ele mantém as configurações enquanto está desligado.
- Abra o menu da linha e escolha Editar para mudar o nome, o endereço ou os eventos, ou Excluir para removê-lo. Nada mais é afetado: seu servidor continua funcionando e o canal simplesmente deixa de receber mensagens.
Bom saber
- Um servidor pode ter até 10 webhooks, por exemplo um por canal.
- Para manter um canal legível, cada webhook envia no máximo 4 mensagens por minuto e 40 por hora. As mensagens além disso são puladas em vez de enviadas com atraso, e a mensagem seguinte diz quantas atualizações anteriores foram puladas.
- Se o webhook for excluído no Discord, o painel o desliga sozinho na próxima vez que tentar enviar, e a linha mostra Desligado. Crie um novo webhook no Discord, escolha Editar, cole o novo endereço e depois ligue-o de novo.
- Não há botão de teste. Para testar um webhook novo, marque Servidor iniciado e reinicie seu servidor. A mensagem chega logo depois que o servidor fica pronto.
- Os webhooks são para um canal que seu grupo compartilha. Para alertas só para você, no painel ou por e-mail, veja Como gerenciar as notificações e as preferências.
Para suas próprias ferramentas
Um endereço que não é um webhook do Discord recebe um POST com um corpo JSON:
sourceéPlayNHost.eventsé uma lista. Cada evento tem umtype(comoserver.crashouplayer.join),server(o nome do servidor),at(quando aconteceu), umtitlee umtextlegíveis, e um objetodatacom os detalhes.skippedé quantas mensagens anteriores foram deixadas de fora pelo limite acima.
O endereço precisa usar https e apontar para um endereço público na internet. Redirecionamentos não são seguidos. As mensagens não são assinadas, então mantenha o próprio endereço em segredo.
Veja também
- Como ver o que aconteceu no seu servidor mostra quem iniciou, parou ou mudou o quê, e quando.
- Como resolver um servidor que não inicia ajuda quando um alerta de queda não para de chegar.
