WebHook

WebHookプラグインは、AMMDSプラットフォームに指定されたWebHook URLにプッシュ通知を送信する機能を提供し、ユーザーがリアルタイムのシステムイベント通知を受け取れるようにします。WebHookを通じて、ユーザーはAMMDSプラットフォームの各種イベント（タスク完了、システムアラート、ステータス変更など）を外部システムにリアルタイムでプッシュし、サードパーティサービスとの統合を実現できます。

プラグイン設定

プラグイン設定項目

• 有効化ステータス: WebHookプラグインを有効にするかどうかを制御します。無効にすると、すべてのWebHookサービスが通知の送信を停止します。
• 再試行回数: 通知送信失敗後の再試行回数を設定します。WebHookリクエストが失敗した場合、システムは設定された回数に従って自動的に再試行します。
• 再試行間隔: 各再試行間の時間間隔（単位：秒）を設定します。再試行間隔を合理的に設定すると、ターゲットサーバーに過度な負荷をかけるのを防ぐことができます。

WebHookサービス設定

プラグインは複数のWebHookサービスを同時に設定することをサポートしています。各サービスはURLと通知コンテンツ形式を独立して設定できます。ユーザーは異なる通知シナリオに応じて複数のWebHookサービスを作成できます。例えば：

• システムアラート通知
• タスクステータス変更通知
• 重要イベント通知
• データ同期通知

WebHookサービスの追加

「追加」ボタンをクリックして、新しいWebHookサービスを追加する設定ダイアログを開きます。

WebHookサービス設定項目

基本設定

• サービス名: WebHookサービスに識別名を設定し、管理と識別に使用します。「システムアラート通知」、「タスク完了通知」など、説明的な名前を使用することをお勧めします。
• URL: プッシュ通知を受け取るWebHookアドレスを指定します。このアドレスに正常にアクセスでき、POSTリクエストを処理できることを確認してください。
• 説明: WebHookサービスに説明を追加し、サービスの用途や目標を説明します。詳細な説明は後続の管理と保守に役立ちます。
• 有効化ステータス: このWebHookサービスを有効にするかどうかを制御します。無効にすると、このサービスは通知の送信を停止しますが、設定は保持されます。

リクエストヘッダー設定

• リクエストヘッダー: WebHookリクエストのカスタムリクエストヘッダーを設定し、形式はキー: 値、1行に1つです。一般的なリクエストヘッダーには以下が含まれます：
  • Content-Type: application/json: リクエストボディ形式をJSONとして指定
  • Authorization: Bearer <token>: 認証トークンを追加し、API呼び出しのセキュリティを保証
  • X-Custom-Header: <value>: カスタムビジネスヘッダー情報を追加
• 「追加」ボタンをクリックして複数のカスタムリクエストヘッダーを追加できます

リクエストボディ設定

• コンテンツ形式: リクエストボディはJSON形式である必要があります。プラグインは通知コンテンツを自動的にJSON文字列に変換して送信します。ユーザーは受信側のニーズに応じてJSON構造をカスタマイズできます。例えば：

  {
    "event": "{{type}}",
    "title": "{{title}}",
    "message": "{{message}}",
    "timestamp": "{{time}}",
    "data": {
      "logo": "{{logo}}",
      "image": "{{image}}",
      "sign": "{{sign}}"
    }
  }

プッシュ確認

• 確認タイプ: WebHookレスポンスの確認方法を設定し、通知送信の成功を保証します
  • ステータスコード: レスポンスステータスコードが200であるかどうかを確認します。標準的なREST APIインターフェースに適用されます。
  • コンテンツ: レスポンスコンテンツに指定された文字列が含まれているかどうかを確認します。カスタムインターフェースまたは特定のレスポンスコンテンツが必要なシナリオに適用されます。

変数の説明

変数	説明
{{sign}}	署名、通知の真正性を確認するために使用
{{title}}	通知タイトル、イベントコンテンツを簡潔に説明
{{subTitle}}	通知サブタイトル、追加のイベント情報を提供
{{logo}}	ロゴURL、イベントに関連するアイコンまたは識別子
{{image}}	画像URL、イベントに関連する画像リソース
{{message}}	メッセージ本文、イベントコンテンツを詳細に説明
{{time}}	プッシュ時間、イベント発生のタイムスタンプ
{{type}}	イベントタイプ、イベントのカテゴリを識別

リクエストボディとリクエストヘッダーで上記の変数を使用でき、プラグインが自動的に実際の値に置換します。

使用シナリオ

WebHookプラグインは以下のシナリオに適しています：

1. システム監視統合: AMMDSプラットフォームのアラート情報をPrometheus、Grafanaなどの監視システムにプッシュします。
2. ワークフロー自動化: AMMDSプラットフォームのタスクが完了すると、自動デプロイ、データ同期などの外部システムの後続操作をトリガーします。
3. 通知リマインダー: 企業WeChat、DingTalk、Slackなどの企業内コミュニケーションツールに重要イベントをプッシュします。
4. データバックアップ: WebHookを通じてAMMDSプラットフォームの重要なデータを定期的にバックアップシステムにプッシュします。

ベストプラクティス

1. セキュリティ: WebHook URLでHTTPSプロトコルを使用し、平文転送を回避します。認証が必要なインターフェースの場合、リクエストヘッダーを使用して認証情報を追加します。
2. 信頼性: 再試行回数と間隔を合理的に設定し、通知が確実に配信されるようにします。
3. パフォーマンス: WebHook処理ロジックで時間のかかる操作を実行せず、応答を迅速に保ちます。
4. 監視: WebHookの送信ステータスを監視し、問題を及时发现して解決します。
5. バージョン管理: WebHook設定を変更する場合、既存の統合に影響を与えないように下位互換性に注意します。