このページは機械翻訳です。英語版がソースであり、より正確または最新の場合があります。 英語で表示

Webhook のテスト - ダッシュボードツールと監視

finlight のダッシュボードは、webhook 統合が確実に動作するよう、包括的なテストおよび監視ツールを提供します。これらの組み込み機能を使って、webhook エンドポイントを検証・テスト・デバッグしましょう。

概要

ダッシュボード機能の概要

主なダッシュボードツール

Webhook リスト:

  • 構成済みのすべての webhook を表示
  • ステータス（有効/無効）を一目で確認
  • webhook の詳細にすばやくアクセス

Webhook 詳細ページ:

  • 設定タブ - webhook の設定を表示/編集
  • 呼び出し履歴タブ - すべての配信試行を表示
  • テストボタン - 手動テスト機能

呼び出し履歴の機能:

  • ステータスフィルタリング - 成功または失敗のみを表示
  • 詳細ログ - エントリをクリックすると、完全なリクエスト/レスポンスデータを表示
ダッシュボード管理インターフェース

Webhook 詳細ダッシュボード

app.finlight.me/news-webhooks で webhook 管理インターフェースにアクセスし、すべての webhook を表示・管理できます。

Webhook 詳細へのアクセス

  1. ダッシュボードの webhook リストに移動します
  2. webhook の「Show」ボタンをクリックして詳細ページを表示します
  3. webhook の構成とパフォーマンスに関する包括的な情報を確認します

webhook 詳細ページでは、次の情報が得られます：

  • 構成の概要 - 現在の設定とフィルタリング条件
  • 呼び出し履歴 - すべての webhook 試行の完全なログ
  • テストコントロール - 手動テスト機能
  • 編集コントロール - 作成後の手動編集
テストテストボタン

手動テスト

Webhook テスト機能

ダッシュボードには、エンドポイントにサンプルペイロードを送信する 「Test」 ボタンがあります：

使い方:

  1. webhook の詳細ページを開きます
  2. 上部パネルの 「Test」 ボタンをクリックします
  3. テストリクエストが完了するまで数秒待ちます
  4. 呼び出し履歴でテスト結果を確認します（ページの再読み込みが必要な場合があります）

何が起こるか:

  • 構成済みのエンドポイントに、リアルなサンプルペイロードを送信します
  • 実際の認証設定を使用します
  • 適切な署名検証ヘッダーを含みます
  • テスト試行を呼び出し履歴に記録します

テストペイロード: テストは、実際の webhook 配信と同じ構造に従う模擬の記事イベントを送信し、次の点を検証できます：

  • エンドポイントのアクセス可能性と応答
  • 認証の構成
  • ペイロード処理ロジック
  • エラー処理の能力
履歴配信ログ

呼び出し履歴と監視

呼び出し履歴の表示

webhook 詳細ページには、すべての配信試行を示す包括的な呼び出し履歴が表示されます：

表示される情報:

  • タイムスタンプ - webhook が送信された時刻
  • ステータス - 成功 (2xx) または失敗 (4xx/5xx)
  • 応答コード - エンドポイントが返した HTTP ステータスコード
  • 応答時間 - エンドポイントが応答するまでの時間
  • 応答 - 「Show」をクリックするとドロップダウン内に表示される応答全体（ヘッダーとボディ）

成功したリクエストと失敗したリクエスト

成功したリクエスト (✅):

  • HTTP ステータスコード 200-299
  • タイムアウト期間内に受信した応答
  • エンドポイントからの適切な確認応答

失敗したリクエスト (❌):

  • HTTP ステータスコード 400-599
  • ネットワークのタイムアウトまたは接続エラー
  • 認証の失敗
  • 無効なエンドポイント URL
デバッグトラブルシューティング

ダッシュボードでのデバッグ

デバッグに呼び出し履歴を使う

呼び出し履歴は、webhook の問題を診断するための主要なツールです：

パターンの特定:

  1. ステータスでフィルタ - 失敗したリクエストのみを表示して問題を特定します
  2. タイムスタンプを確認 - 失敗のタイミングのパターンを探します
  3. 応答コードを確認 - エンドポイントが何を返しているかを把握します
  4. 再試行を調べる - 配信が何回試行されたかを確認します

よくある失敗の兆候:

  • HTTP 401/403 - 認証または認可の問題
  • HTTP 404 - 誤ったエンドポイント URL
  • HTTP 500 - アプリケーション内のサーバー内部エラー
  • タイムアウト - エンドポイントの応答に時間がかかりすぎている
  • 接続エラー - ネットワーク接続の問題

詳細なエラー情報

呼び出し履歴の任意のエントリをクリックすると、次の内容が表示されます：

  • エンドポイントに送信された完全なリクエストヘッダー
  • エンドポイントから受信した応答ヘッダー
  • 応答ボディの内容（ある場合）
  • 正確なタイミング情報
  • 失敗した試行の再試行履歴
要件実装ガイドライン

エンドポイントの要件

応答の要件

webhook エンドポイントは次の条件を満たす必要があります：

HTTP 応答:

  • 処理が成功した場合はステータスコード 200-299 を返す
  • タイムアウトを避けるため 30 秒以内に応答する
  • JSON ペイロードを伴う POST リクエストを受け付ける

ヘッダー:

  • 署名検証のために X-Webhook-Signature を処理する
  • リプレイ攻撃防止のために X-Webhook-Timestamp を扱う
  • 選択した認証方法のヘッダーをサポートする

webhook 設定のガイダンスについては、webhook のメインドキュメントを参照してください。認証の詳細については、認証ガイドを確認してください。