Начало работы с Echobell - полное руководство по настройке

Добро пожаловать в Echobell — приложение для мгновенных оповещений, которое помогает не упускать важные уведомления. Если вы разработчик, которому нужны оповещения по вебхукам для CI/CD-пайплайна, системный администратор, следящий за серверами, или команда, работающая с критическими уведомлениями, это подробное руководство проведёт вас через настройку и эффективное использование Echobell.

К концу руководства вы будете знать, как создавать каналы уведомлений, настраивать триггеры по вебхуку и email, менять шаблоны уведомлений и подключать Echobell к вашим текущим инструментам и рабочим процессам.

Что такое Echobell?

Echobell — мощный инструмент управления уведомлениями для разработчиков, DevOps-команд и всех, кому нужны надёжные мгновенные оповещения. Он связывает ваши системы с мобильным устройством, чтобы критически важная информация доходила до вас немедленно.

Ключевые возможности:

• Интеграция по вебхукам: подключите любую систему, способную отправлять HTTP-запросы — инструменты мониторинга, CI/CD-пайплайны, IoT-устройства и другие
• Email-триггеры: превратите любое письмо в мгновенное уведомление, переслав его на выделенный email-адрес канала
• Настраиваемые шаблоны: используйте динамические переменные, чтобы получать информативные уведомления с полным контекстом
• Гибкие типы уведомлений: выбирайте между обычными уведомлениями, срочными оповещениями и уведомлениями в виде телефонного звонка для критических ситуаций
• Приватность по умолчанию: история уведомлений остаётся на вашем устройстве, а не на наших серверах
• Совместная работа в команде: делитесь каналами с коллегами и управляйте доступом подписчиков

Узнайте больше о том, чем уникален Echobell, и посмотрите полный обзор возможностей.

Основные понятия

Прежде чем начать, разберём ключевые понятия:

Каналы

Канал — основная единица Echobell для организации и рассылки уведомлений:

• У каждого канала есть уникальные имя и цвет, чтобы вы легко различали источники оповещений
• Каналы содержат шаблоны уведомлений, которые определяют, какая информация отправляется подписчикам
• Каналы запускаются через вебхуки или письма
• Вы можете создавать собственные каналы или подписываться на каналы, которыми поделились другие
• Каждый канал поддерживает условия, чтобы фильтровать, какие срабатывания триггеров действительно приводят к уведомлениям
• Каналами можно делиться с коллегами или публично через защищённые ссылки подписки

Считайте канал конвейером уведомлений: данные поступают через триггеры, форматируются шаблонами, фильтруются условиями и доставляются в виде уведомлений всем подписчикам.

Триггеры

Триггер — это то, что заставляет канал отправить уведомления. Echobell поддерживает два способа запуска:

• Вебхук: URL-адрес, обращение к которому по HTTP GET или POST активирует канал. Подходит для интеграции с системами мониторинга, CI/CD-пайплайнами, бессерверными функциями и любым инструментом, способным отправлять HTTP-запросы.

• Email-триггер: уникальный email-адрес, привязанный к каналу. Когда на этот адрес приходит письмо, канал активируется. Подходит для оповещений по электронной почте, пересылки важных сообщений и систем, которые умеют отправлять только email-уведомления.

В одном канале можно одновременно использовать оба типа триггеров — это даёт максимальную гибкость в способах отправки оповещений. Подробнее об интеграции по вебхукам и email-триггерах.

Типы уведомлений

При подписке на канал вы выбираете один из стилей уведомлений, который определяет, как оповещения выглядят на вашем устройстве:

• Обычное (активное): стандартное уведомление приложения, которое появляется в центре уведомлений. Подходит для несрочных обновлений и информационных оповещений.

• Срочное: уведомление с высоким приоритетом, которое пробивается через режимы фокусирования и настройку «Не беспокоить». Рекомендуется для важных оповещений, которые требуют внимания сразу, но не являются критической аварией.

• Звонок: оповещение в виде звонка с рингтоном и полноэкранным интерфейсом — как входящий телефонный вызов. Необходимо для критических инцидентов, требующих немедленной реакции: сбоев в продакшене или предупреждений безопасности.

Выбор типа уведомления зависит от срочности содержимого канала. При необходимости можно подписаться на один и тот же канал несколько раз с разными типами уведомлений. Прочитайте подробное руководство по уведомлениям, чтобы понять, когда какой тип использовать.

Начало работы

1. Настройка аккаунта

1. Скачайте Echobell в App Store / Google Play
2. Откройте приложение и войдите по email или через «Вход с Apple»

2. Создание первого канала

1. На главном экране нажмите кнопку в правом нижнем углу, чтобы перейти к разделу Каналы
2. Нажмите кнопку +, чтобы создать новый канал
3. Введите имя канала (например, «Оповещения серверов»)
4. Выберите цвет, по которому будете узнавать канал
5. Настройте шаблоны уведомлений:
   • Шаблон заголовка: то, что появится в заголовке уведомления
   • Шаблон текста: подробное содержимое уведомления
6. При желании включите подписку на этот канал для себя
7. Выберите тип уведомления для канала (обычное, срочное или звонок)
8. Сохраните новый канал

3. Настройка триггера

После создания канала уведомления можно запускать двумя способами: через вебхуки или письма. Нажмите на только что созданный канал, чтобы открыть его настройки. В настройках канала есть раздел Триггеры.

Триггер по вебхуку

1. Нажмите кнопку webhook, чтобы скопировать сгенерированный URL вебхука
2. Встройте этот URL в свои системы (например, в мониторинг серверов или CI/CD-пайплайн)
3. При обращении к этому URL канал будет запущен

Передать переменные в шаблоны уведомлений можно двумя способами:

# Example webhook call with query parameters
curl -X GET "https://hook.echobell.one/t/<channel-token>?server=production&status=critical&message=CPU%20usage%20at%2095%25"

# OR with JSON body
curl -X POST https://hook.echobell.one/t/<channel-token> \
  -H "Content-Type: application/json" \
  -d '{"server": "production", "status": "critical", "message": "CPU usage at 95%"}'

Эти переменные подставляются в шаблоны уведомлений. Например, если шаблон заголовка — {{server}} - {{status}}, он отрисуется как «production - critical».

Специальные переменные:

• externalLink: если передать эту переменную, она отобразится как кликабельная ссылка в записях уведомлений

Email-триггер

1. Нажмите кнопку email, чтобы скопировать сгенерированный email-адрес канала
2. Когда на этот адрес приходит письмо, канал запускается

При работе с email-триггерами Echobell автоматически извлекает из письма такие переменные:

• from: email-адрес отправителя
• to: email-адрес получателя (email вашего канала)
• subject: тема письма
• text: текстовое содержимое письма
• html: HTML-содержимое письма

Эти переменные можно использовать в шаблонах, например {{subject}} или {{text}}.

4. Настройка шаблонов уведомлений

Шаблоны используют переменные, которые заполняются данными триггера:

1. В настройках канала перейдите к разделу Шаблоны уведомлений
2. Для шаблона заголовка можно взять: {{server}} - {{status}}
3. Для шаблона текста подойдёт: {{message}} Detected at {{timestamp}}
4. Переменные заключаются в двойные фигурные скобки: {{variable_name}}
5. Проверьте шаблон на тестовых данных

5. Подписка на каналы

1. Вы можете отправить другим ссылку подписки на свои каналы
2. Либо использовать ссылки подписки, которыми поделились другие, чтобы подписаться на их каналы
3. Нажмите Подписаться на экране каналов
4. Введите ссылку подписки
5. Выберите нужный тип уведомления:
   • обычное — для стандартных оповещений
   • срочное — для важных оповещений
   • звонок — для критических ситуаций
6. Подтвердите подписку

Настройки приложения

Поведение Echobell при обработке уведомлений можно изменить в этих настройках:

• Повторять голосовое содержимое: при звонковых уведомлениях содержимое уведомления будет проговариваться повторно
• Повторять несостоявшийся звонок: автоматически повторять звонковые уведомления, которые не прошли из-за режима фокусирования или по другим причинам

Приватность и хранение данных

Echobell ставит вашу приватность на первое место:

• На наших серверах хранятся только аккаунты пользователей, каналы и данные подписок
• Содержимое и история уведомлений хранятся локально на вашем устройстве
• Данные ваших оповещений остаются под вашим контролем

Дальнейшие шаги

Теперь, когда первый канал настроен, изучите эти материалы, чтобы получить от Echobell максимум:

Основные руководства

• Что такое Echobell? - основные понятия и подход, лежащий в основе Echobell
• Обзор возможностей - все доступные функции и возможности
• Руководство по шаблонам - синтаксис шаблонов и создание динамических уведомлений
• Условия - фильтрация уведомлений по данным триггера
• Интеграция по вебхукам - подробный разбор настройки вебхуков и рекомендации
• Email-триггеры - настройка запуска уведомлений по электронной почте

Руководства по интеграциям

Подключите Echobell к популярным инструментам и платформам:

• Интеграция с Grafana - мониторинг инфраструктуры с мгновенными оповещениями
• GitHub Actions - уведомления о событиях CI/CD-пайплайна
• Prometheus - настройка оповещений по метрикам Prometheus
• Home Assistant - уведомления от автоматизаций умного дома
• Мониторинг доступности - оповещения о доступности сайтов и сервисов
• TradingView - торговые оповещения и уведомления о рынке

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

• Начинайте с простого: сначала создайте базовые каналы с простыми шаблонами, затем постепенно усложняйте
• Проверяйте шаблоны: до внедрения делайте тестовые вызовы вебхука, чтобы убедиться, что шаблоны отрисовываются правильно
• Разумно используйте условия: отсекайте шум, задавая условия каналов так, чтобы оповещения приходили только по важным событиям
• Подбирайте подходящий тип уведомления: оставьте уведомления типа «звонок» для действительно критических оповещений, чтобы избежать усталости от оповещений
• Организуйте цветом: продуманно используйте цвета каналов, чтобы с одного взгляда определять источник оповещения
• Описывайте свои каналы: в заметках канала фиксируйте, что его запускает и как на это реагировать

Частые сценарии использования

Как Echobell используют другие:

• Мониторинг серверов: мгновенные оповещения, когда загрузка CPU, памяти или диска превышает пороги
• Уведомления CI/CD: сразу узнавать о падении сборок и завершении развёртываний
• Оповещения для интернет-магазинов: уведомления о новых заказах, проблемах с оплатой или остатках на складе
• Мониторинг безопасности: критические оповещения об ошибках аутентификации, подозрительной активности и событиях безопасности
• IoT и умный дом: уведомления от датчиков, камер и систем домашней автоматизации
• Координация команды: общие каналы для совместного реагирования на инциденты

Получить помощь

Нужна помощь или есть вопросы?

• Центр поддержки - частые вопросы и руководства по решению проблем
• Поддержка по email: пишите нам на echobell@weelone.com
• Сообщество: участвуйте в обсуждениях и делитесь своими сценариями с другими пользователями Echobell

Готовы подключить Echobell к своим системам? Начните с руководства по интеграции вебхуков или изучите интеграции для разработчиков.