WebHookの送信履歴を確認する

CloudGear ServiceManagerのWebHook管理画面では、CloudGearがサービスに対して過去に送信したWebHookの履歴を確認したり、送信に失敗したWebHookの再送信を試行することができます。

WebHook送信履歴の確認方法

WebHookの履歴を確認するには、次の手順に従います。

CloudGear ServiceManager（https://servicemanager.cloudgear.services/）にログインし、WebHookの送信設定を行うCloudGearアプリケーションのダッシュボードを表示します。

サービス管理メニューの「WebHook」リンクをクリックすると、WebHookの送信履歴のリストが表示されます。

WebHookごとの詳細情報を表示するには、リスト中の目的のWebHookの行をクリックします。

WebHookごとの詳細情報には、WebHookの一覧に記載されている項目に加え、以下の項目が表示されます。

カラム名	説明
送信日時	CloudGearサーバーがWebHookリクエストを送信した日時を表します。
ステータス	リクエストの状況を表します。 SUCCESS リクエストは正常に完了しました。 PENDING WebHookリクエストの再送信を試行しています。 ERROR WebHookエンドポイントがエラーを返却しました。 TIMEOUT リクエストがWebHookエンドポイントに到達できませんでした。
WebHookバージョン	WebHookのバージョンを表します。
イベント	WebHookのイベントタイプを表します。
送信先エンドポイント	WebHookが送信されたエンドポイントURLを表します。
HTTPステータスコード	WebHookエンドポイントが返却したHTTPステータスコードを表します。
スクエアID	WebHookの送信先スクエアIDを表します。
契約ID	WebHookが関連する契約のIDです。クリックすると契約詳細ページに遷移します。この項目は、イベントタイプが `profile.update` の場合は表示されません。

CloudGearが過去に送信したWebHookリクエストがWebHookエンドポイントによって正常に処理できなかった場合、そのWebHookリクエストの送信を再試行することができます。
WebHookリクエストの再送信を行うには、以下の手順に従います。

送信履歴の確認方法に従い、再送信したいWebHookの詳細情報画面を表示します。

WebHookの詳細情報画面内に表示されている[再送信]ボタンをクリックすると、再送信がキューイングされます。
正常に再送信がキューイングされると、そのWebHookのステータスは PENDING となります。

WebHookの再送信はキューイングによって順次実行されるため、リクエストの送信まで最大数分程度掛かる場合があります。

再送信キューが処理されると、WebHookのステータスは SUCCESS ERROR TIMEOUT のいずれかとなります。