イベント・フックのプレビュー

イベント・フックのプレビューを行うと、管理者が新しいイベント・フックを有効にする前にプレビューして、カスタムコードとの相互作用を確認できます。イベント・フックのプレビューでは、イベント・フック・リクエストのJSONペイロードが表示されます。管理者は、JSONペイロードを配信前に編集することで、イベントに対するコードの応答についてトラブルシューティングを行うことができます。

あるイベント・タイプに対してイベントが生成されない場合、イベント・フックのプレビューにはサンプル・データを含むサンプル・イベントが表示されます。未確定のフィールドはnullに設定され、テスト用にカスタム値に置き換えることができます。

イベント・フックのプレビューを構成する

イベント・フック・リクエストを構成して、コードの応答をトラブルシューティングします。デフォルトでは、アクティブなイベント・フックが最初に表示されますが、タイプまたは名前で表を並べ替えることができます。

開始する前に

  • イベント・フックを表示および構成できるのはスーパー管理者のみです。
  • サンプルのイベント・フックのプレビュー・リクエストは、最近のイベントの実際の値を使用して生成されます。生成されていないイベントのプレビュー・リクエストにはサンプル値が含まれています。
  • イベント・フックのJSONペイロードにはイベント・データが含まれています。

イベント・フックのプレビューを構成するには

  1. 管理コンソールで、[ワークフロー] > [イベント・フック]に移動します。
  2. プレビューするイベント・フックを探し、その[アクション]メニューをクリックします。
  3. [プレビュー]を選択します。
  4. [プレビュー]タブで次のタスクを実行します。
    • [イベント・フック・リクエストの設定]セクションで、[イベント・タイプ]ドロップ・ダウン・メニューからイベントを選択します。
    • [システム・ログ・イベント]ドロップ・ダウン・メニューからイベントを選択します。選択したイベント・タイプに対してイベントが生成されない場合、サンプルのイベントが表示されます。
    • [プレビュー] & [イベント・フックを配信]にリクエストのJSONペイロードが表示されます。リクエストのサンプルJSONペイロードにイベント・データが含まれていることを確認します。
    • [編集]をクリックしてJSONペイロードをさらに編集し、[保存]をクリックします。
    • [リクエストを配信]をクリックします。

JSONペイロードを表示および編集する

イベント・フックのプレビューには、イベント・フック・リクエストのJSONペイロードが表示されます。あるイベント・タイプに対してイベントが生成されない場合、イベント・フックのプレビューにはサンプル・データを含むサンプル・イベントが表示されます。未確定のフィールドはnullに設定され、テスト用にカスタム値に置き換えることができます。

管理者は、ペイロードを配信する前にJSONペイロードを編集することで、イベントに対するコードの応答についてトラブルシューティングを行うことができます。

イベント・フックのプレビュー・ステータス

イベント・フックのプレビューには、イベント・フック・リクエストのステータスが成功または失敗として表示されます。

関連項目

イベント・フックを追加する

エンドポイントを確認する