Перейти к основному содержимому

🪝 Интеграция Webhook

Обзор

Open WebUI предоставляет функцию вебхуков, которая позволяет вам автоматически получать уведомления всякий раз, когда новые пользователи регистрируются в вашей системе. Для этого необходимо указать URL вебхука в Open WebUI, который будет отправлять уведомления на этот URL при создании нового аккаунта пользователя.

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

Вам нужно получить URL вебхука от внешнего сервиса, поддерживающего вебхуки, например, от канала Discord или рабочего пространства Slack. Этот URL будет использоваться для получения уведомлений от Open WebUI.

Для настройки вебхуков в Open WebUI у вас есть два варианта:

Вариант 1: Настройка через интерфейс администратора

  1. Войдите в свой экземпляр Open WebUI как администратор.
  2. Перейдите в Панель администратора.
  3. Нажмите на вкладку Настройки, расположенную вверху.
  4. Оттуда перейдите в раздел Общие настроек в панели администратора.
  5. Найдите поле Webhook URL и введите URL вебхука.
  6. Сохраните изменения.

Вариант 2: Настройка через переменные окружения

Альтернативно, вы можете настроить URL вебхука, задав переменную окружения WEBHOOK_URL. Для получения дополнительной информации о переменных окружения в Open WebUI см. Конфигурация переменных среды.

Шаг 3: Проверка вебхука

Чтобы проверить, работает ли вебхук корректно, создайте новый аккаунт пользователя в Open WebUI. Если вебхук настроен правильно, вы должны получить уведомление на указанный URL вебхука.

Формат полезной нагрузки вебхука

Полезная нагрузка вебхука, отправляемая Open WebUI, представлена в виде простого текстового сообщения с уведомлением о новом аккаунте пользователя. Формат полезной нагрузки выглядит следующим образом:

Новый пользователь зарегистрировался: <username>

Например, если пользователь по имени "Tim" зарегистрируется, отправленная полезная нагрузка будет:

Новый пользователь зарегистрировался: Tim

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

  • Убедитесь, что URL вебхука указан правильно и имеет корректный формат.
  • Проверьте, что служба вебхуков активирована и настроена правильно.
  • Проверьте журналы Open WebUI на предмет ошибок, связанных с вебхуками.
  • Убедитесь, что соединение не прервано или заблокировано брандмауэром или прокси-сервером.
  • Сервер вебхуков может быть временно недоступен или испытывать высокую задержку.
  • Если используется API-ключ вебхука, убедитесь, что он не является недействительным, истекшим или отозванным.

Примечание: Функция вебхуков в Open WebUI находится в стадии развития. Мы планируем добавить больше возможностей и типов событий в будущем.