Echobell
App Store Google Play

Интеграция с GitHub — оповещения о событиях репозитория и CI/CD

Настройте вебхуки GitHub вместе с Echobell и получайте мгновенные оповещения на телефон о pull request, issue, релизах и упавших запусках CI/CD-workflow.

GitHub — ведущая мировая платформа для контроля версий и совместной работы, которой пользуются миллионы разработчиков. В этом руководстве показано, как подключить вебхуки GitHub к Echobell, чтобы мгновенно получать уведомления о событиях в репозитории — от pull request и коммитов до релизов и запусков workflow.

Если вам нужны мгновенные уведомления из GitHub Actions, используйте Echobell Notification Action, чтобы отправлять уведомления прямо из GitHub Actions.

Предварительные требования

  1. Аккаунт Echobell с активным каналом
  2. Права администратора в репозитории GitHub, за которым нужно следить
  3. URL вебхука Echobell (находится на странице сведений о канале)

Настройка вебхуков GitHub

1. Создайте канал Echobell

  1. Откройте приложение Echobell
  2. Создайте новый канал (например, «GitHub Notifications»)
  3. Настройте шаблоны уведомлений:

Шаблон заголовка:

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

Шаблон тела:

🔔 Event: {{action}}
👤 Actor: {{sender.login}}
📦 Repository: {{repository.full_name}}

2. Получите URL вебхука

  1. В настройках канала найдите раздел Triggers
  2. Скопируйте предложенный URL вебхука
  3. Держите этот URL в секрете — он будет использован в настройках GitHub

3. Настройте вебхук в GitHub

Скриншот настроек вебхуков GitHub

  1. Откройте свой репозиторий на GitHub
  2. Перейдите в Settings → Webhooks
  3. Нажмите Add webhook
  4. Настройте вебхук:
    • Payload URL: URL вебхука Echobell
    • Content type: application/json
    • Secret: (необязательно) добавьте секретный токен для дополнительной безопасности
    • Включите проверку SSL
  5. Выберите события, которые будут запускать вебхук:
    • Выберите «Let me select individual events»
    • Обычно выбирают:
      • Pull requests
      • Push events
      • Issues
      • Discussions
      • Releases
  6. Нажмите Add webhook, чтобы сохранить

Проверка интеграции

  1. После настройки вебхука GitHub отправит событие ping
  2. Проверьте уведомления Echobell, чтобы убедиться в доставке
  3. Создайте тестовый issue или pull request, чтобы проверить интеграцию

Рекомендации

  1. Безопасность:
    • Не раскрывайте URL вебхука
    • Используйте secret вебхука, чтобы запросы можно было проверить
    • Включите проверку SSL
  2. Выбор событий:
    • Подписывайтесь только на нужные события
    • Учитывайте размер и активность репозитория при выборе событий
  3. Обработка ошибок:
    • Следите за статусом доставки вебхуков в GitHub
    • Проверяйте историю уведомлений Echobell на предмет успешной доставки

Устранение неполадок

Если уведомления не приходят:

  1. Проверьте, что URL вебхука указан верно
  2. Посмотрите историю доставки вебхуков в GitHub на наличие ошибок
  3. Убедитесь, что канал Echobell активен
  4. Проверьте, что в канале есть активные подписчики
  5. Проверьте, действительно ли происходят выбранные события

Конфиденциальность и безопасность

  • URL вебхуков следует считать секретами
  • Отправляйте только необходимые данные о событиях
  • Всё содержимое уведомлений хранится локально на устройствах подписчиков
  • Наши серверы только обрабатывают запрос вебхука и маршрутизируют уведомления

Нужна помощь? Загляните в Центр поддержки или напишите нам на echobell@weelone.com.