Zum Hauptinhalt springen

🪝 Webhook Integrations

Übersicht​

Open WebUI bietet eine Webhook-Funktion, mit der Sie automatisch Benachrichtigungen erhalten können, sobald sich neue Benutzer auf Ihrer Instanz anmelden. Dies geschieht, indem Sie eine Webhook-URL an Open WebUI übergeben, die dann Benachrichtigungen an diese URL sendet, wenn ein neues Benutzerkonto erstellt wird.

Webhooks in Open WebUI konfigurieren​

Sie müssen eine Webhook-URL von einem externen Dienst erhalten, der Webhooks unterstützt, z. B. einem Discord-Kanal oder einem Slack-Workspace. Diese URL wird verwendet, um Benachrichtigungen von Open WebUI zu empfangen.

Um Webhooks in Open WebUI zu konfigurieren, haben Sie zwei Möglichkeiten:

Option 1: Konfiguration über die Admin-Oberfläche​

  1. Melden Sie sich als Administrator bei Ihrer Open WebUI-Instanz an.
  2. Navigieren Sie zum Admin-Panel.
  3. Klicken Sie auf die Registerkarte Einstellungen oben.
  4. Navigieren Sie von dort zum Abschnitt Allgemein der Einstellungen im Admin-Panel.
  5. Suchen Sie das Feld Webhook-URL und geben Sie die Webhook-URL ein.
  6. Speichern Sie die Änderungen.

Option 2: Konfiguration über Umgebungsvariablen​

Alternativ können Sie die Webhook-URL konfigurieren, indem Sie die Umgebungsvariable WEBHOOK_URL setzen. Weitere Informationen zu Umgebungsvariablen in Open WebUI finden Sie unter Umgebungsvariablen-Konfiguration.

Schritt 3: Webhook verifizieren​

Um zu überprüfen, ob der Webhook korrekt funktioniert, erstellen Sie ein neues Benutzerkonto in Open WebUI. Wenn der Webhook korrekt konfiguriert ist, sollten Sie eine Benachrichtigung an der angegebenen Webhook-URL erhalten.

Webhook-Payload-Format​

Die von Open WebUI gesendete Webhook-Payload ist im Klartext und enthält eine einfache Benachrichtigungsnachricht über das neue Benutzerkonto. Das Payload-Format ist wie folgt:

New user signed up: <username>

Wenn sich beispielsweise ein Benutzer namens "Tim" anmeldet, wäre die gesendete Payload:

New user signed up: Tim

Fehlerbehebung​

  • Stellen Sie sicher, dass die Webhook-URL korrekt und richtig formatiert ist.
  • Überprüfen Sie, ob der Webhook-Dienst aktiviert und korrekt konfiguriert ist.
  • Überprüfen Sie die Open WebUI-Protokolle auf Fehler im Zusammenhang mit dem Webhook.
  • Überprüfen Sie, ob die Verbindung nicht unterbrochen oder durch eine Firewall oder einen Proxy blockiert wurde.
  • Der Webhook-Server könnte vorübergehend nicht verfügbar sein oder hohe Latenz aufweisen.
  • Wenn über den Webhook-Dienst bereitgestellt, überprüfen Sie, ob der Webhook-API-Schlüssel ungültig, abgelaufen oder widerrufen ist.

Hinweis: Die Webhook-Funktion in Open WebUI entwickelt sich noch weiter und wir planen, in Zukunft weitere Funktionen und Ereignistypen hinzuzufügen.