跳到主要内容

🪝 Webhook 集成

概览​

Open WebUI 提供了一个 webhook 功能，允许您在有新用户注册到您的实例时自动接收通知。这是通过向 Open WebUI 提供一个 webhook URL 来实现的，当创建新用户帐户时，Open WebUI 会将通知发送到该 URL。

在 Open WebUI 中配置 Webhooks​

您需要从支持 webhooks 的外部服务获取一个 webhook URL，例如 Discord 频道或 Slack 工作区。此 URL 将用于接收来自 Open WebUI 的通知。

要在 Open WebUI 中配置 webhooks，您有两种选择

选项 1：通过管理员界面配置​

  1. 以管理员身份登录您的 Open WebUI 实例。
  2. 导航到 管理面板。
  3. 点击顶部的 设置 选项卡。
  4. 然后，导航到管理面板设置中的 通用 部分。
  5. 找到 Webhook URL 字段并输入 webhook URL。
  6. 保存更改。

选项 2：通过环境变量配置​

或者，您可以通过设置 WEBHOOK_URL 环境变量来配置 webhook URL。有关 Open WebUI 中环境变量的更多信息，请参阅 环境变量配置。

步骤 3：验证 Webhook​

要验证 webhook 是否正常工作，请在 Open WebUI 中创建一个新用户帐户。如果 webhook 配置正确，您应该会在指定的 webhook URL 收到通知。

Webhook 有效载荷格式​

Open WebUI 发送的 webhook 有效载荷是纯文本格式，包含关于新用户帐户的简单通知消息。有效载荷格式如下：

New user signed up: <username>

例如，如果一个名为“Tim”的用户注册，发送的有效载荷将是

New user signed up: Tim

故障排除​

  • 确保 webhook URL 正确且格式正确。
  • 验证 webhook 服务已启用并配置正确。
  • 检查 Open WebUI 日志，查找与 webhook 相关的任何错误。
  • 验证连接未被防火墙或代理中断或阻止。
  • Webhook 服务器可能暂时不可用或延迟较高。
  • 如果通过 webhook 服务提供，请验证 Webhook API 密钥是否无效、已过期或已撤销。

注意：Open WebUI 中的 webhook 功能仍在不断发展，我们计划将来添加更多功能和事件类型。