Integração com GitHub - Eventos do repositório e alertas de CI/CD

O GitHub é a principal plataforma de controle de versão e colaboração do mundo, usada por milhões de desenvolvedores. Este guia mostra como integrar os webhooks do GitHub com o Echobell para receber notificações instantâneas de eventos do repositório - de pull requests e commits a releases e execuções de workflows.

Pré-requisitos

1. Uma conta Echobell com um canal ativo
2. Acesso de administrador ao repositório do GitHub que você quer monitorar
3. A URL do seu webhook do Echobell (disponível na tela de detalhes do canal)

Configurando webhooks do GitHub

1. Crie um canal no Echobell

1. Abra o app do Echobell
2. Crie um novo canal (por exemplo, "Notificações do GitHub")
3. Configure os modelos de notificação:

Modelo de título:

[{{repository.name}}] {{action}} por {{sender.login}}

Modelo de corpo:

🔔 Evento: {{action}}
👤 Autor: {{sender.login}}
📦 Repositório: {{repository.full_name}}

2. Obtenha a URL do seu webhook

1. Nas configurações do canal, localize a seção Gatilhos
2. Copie a URL do webhook exibida
3. Mantenha essa URL em segurança, pois ela será usada na configuração do GitHub

3. Configure o webhook no GitHub

1. Acesse o seu repositório no GitHub
2. Vá até Settings → Webhooks
3. Clique em Add webhook
4. Configure o webhook:
   • Payload URL: a URL do seu webhook do Echobell
   • Content type: application/json
   • Secret: (opcional) adicione um token secreto para mais segurança
   • Ative a verificação SSL
5. Escolha quais eventos devem acionar o webhook:
   • Selecione "Let me select individual events"
   • Escolhas comuns incluem:
     • Pull requests
     • Eventos de push
     • Issues
     • Discussões
     • Releases
6. Clique em Add webhook para salvar

Testando a integração

1. Depois de configurar o webhook, o GitHub envia um evento de ping
2. Confira as suas notificações do Echobell para confirmar o recebimento
3. Crie uma issue ou um pull request de teste para verificar a integração

Boas práticas

1. Segurança:
   • Mantenha a URL do seu webhook em sigilo
   • Use um secret de webhook para ter requisições verificadas
   • Ative a verificação SSL
2. Seleção de eventos:
   • Inscreva-se apenas nos eventos de que você precisa
   • Considere o tamanho e a atividade do repositório ao selecionar os eventos
3. Tratamento de erros:
   • Acompanhe o status de entrega do webhook no GitHub
   • Verifique o histórico de notificações do Echobell para confirmar a entrega

Solução de problemas

Se você não estiver recebendo notificações:

1. Verifique se a URL do webhook está correta
2. Confira o histórico de entregas do webhook no GitHub em busca de erros
3. Certifique-se de que o seu canal do Echobell está ativo
4. Verifique se você tem inscritos ativos no canal
5. Confira se os eventos selecionados estão sendo acionados

Privacidade e segurança

• As URLs de webhook devem ser tratadas como segredos
• Envie apenas os dados de evento necessários
• Todo o conteúdo das notificações fica armazenado localmente nos dispositivos dos inscritos
• Nossos servidores apenas processam a requisição do webhook e encaminham as notificações

Precisa de ajuda? Acesse a nossa Central de Suporte ou entre em contato pelo e-mail echobell@weelone.com.