🪝 Webhookインテグレーション
概要
Open WebUIは、自分のインスタンスに新規ユーザーが登録されるたびに通知を受け取ることができるWebhook機能を提供しています。この機能はWebhook URLをOpen WebUIに提供することで、新しいユーザーアカウントが作成される際にそのURLに通知を送信する仕組みです。
Open WebUIでのWebhook設定
Webhookを設定するには、DiscordチャンネルやSlackワークスペースなどの外部サービスからWebhook URLを取得してください。このURLはOpen WebUIから通知を受信するために使用されます。
Open WebUIでWebhookを設定するには、以下の2つのオプションがあります：
オプション1: 管理画面を通じて設定
- 管理者としてOpen WebUIインスタンスにログインします。
管理パネルに移動します。- 上部にある
設定タブをクリックします。 - そこから管理パネル内の
一般セクションに移動します。 Webhook URLフィールドを見つけてWebhook URLを入力します。- 変更を保存します。
オプション2: 環境変数を通じて設定
または、WEBHOOK_URL環境変数を設定することでWebhook URLを設定することもできます。Open WebUIにおける環境変数の詳細については、環境変数設定をご参照ください。
ステップ3: Webhookの確認
Webhookが正しく動作していることを確認するには、Open WebUIで新しいユーザーアカウントを作成してください。Webhookが正しく設定されている場合、指定したWebhook URLに通知が届くはずです。
Webhookペイロード形式
Open WebUIによって送信されるWebhookペイロードはプレーンテキスト形式であり、新しいユーザーアカウントに関するシンプルな通知メッセージを含んでいます。ペイロード形式は以下の通りです：
新しいユーザーが登録しました: <ユーザー名>
例えば、「Tim」という名前のユーザーが登録した場合、送信されるペイロードは以下のようになります：
新しいユーザーが登録しました: Tim
トラブルシューティング
- Webhook URLが正しくフォーマットされていることを確認してください。
- Webhookサービスが有効化され、正しく設定されていることを確認してください。
- Open WebUIのログでWebhookに関連するエラーがないか確認してください。
- 接続がファイアウォールやプロキシによって中断されたり、ブロックされていないことを確認してください。
- Webhookサーバーが一時的に利用できない、または高いレイテンシが発生している可能性があります。
- Webhookサービスが提供している場合、Webhook APIキーが無効、有効期限切れ、または取り消されていないか確認してください。
注意: Open WebUIのWebhook機能はまだ進化中であり、今後さらに多くの機能やイベントタイプを追加する予定です。