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

Event Hook Previewを使用して、新しいイベントフックを有効化する前にプレビュー表示して、カスタムコードとどのように連携するかを確認できます。Event Hook Previewでは、イベントフック要求のJSONペイロードが表示されるため、管理者はこれを利用してJSONペイロードを配信する前に編集することで、イベントに対するコードのレスポンスに関してトラブルシューティングを行えます。

そのイベントタイプでイベントが生成されない場合、Event Hook Previewはサンプルデータを使用してサンプルのイベントを表示します。未決定のフィールドはnullに設定されますが、テスト用にカスタム値に置き換えることができます。

Event Hook Previewの構成

イベントフックの要求を構成してから、コードがどのようにレスポンスを返すかに関してトラブルシューティングします。デフォルトでは、アクティブなイベントフックが先頭に表示されますが、タイプや名前でテーブルを並べ替えることもできます。

開始する前に

  • スーパー管理者のみがイベントフックの表示、構成を行えます。
  • サンプルのEvent Hook Preview要求は、直近のイベントの実際の値で生成されます。生成されていないイベントのプレビュー要求にはサンプル値が含まれます。
  • イベントフックJSONペイロードにはイベントデータが含まれます。

Event Hook Previewを構成するには

  1. 管理コンソールで、[Workflow(ワークフロー)] > [Event Hooks(イベントフック)]の順に移動します。
  2. プレビュー表示するイベントフックを見つけて、[Actions(アクション)]メニューをクリックします。
  3. [Preview(プレビュー)]を選択します。
  4. [Preview(プレビュー)]タブで次のタスクを完了します:
    • [Configure Event Hook request(イベントフックの要求の構成)]セクションで、[Event Type(イベントタイプ)]のドロップダウンメニューからイベントを選択します。
    • [System Log Event(システム・ログ・イベント)]ドロップダウンメニューからイベントを選択します。選択されたイベントタイプでイベントが生成されない場合、サンプルのイベントが表示されます。
    • [Preview & Deliver Event Hook(イベントフックのプレビューと配信)]は、要求のJSONペイロードを表示します。要求のサンプルのJSONペイロードにイベントデータが含まれていることを確認します。
    • [Edit(編集)]をクリックしてJSONペイロードに追加の編集を加えてから、[Save(保存)]をクリックします。
    • [Deliver Request(要求を配信)]をクリックします。

JSONペイロードの表示と編集

Event Hook Previewは、イベントフック要求のJSONペイロードを表示します。そのイベントタイプでイベントが生成されない場合、Event Hook Previewはサンプルデータを使用してサンプルのイベントを表示します。未決定のフィールドはnullに設定されますが、テスト用にカスタム値に置き換えることができます。

管理者はJSONペイロードを配信する前に編集することで、イベントに対するコードのレスポンスに関してトラブルシューティングを行えます。

Event Hooks Previewのステータス

Event Hook Previewは、イベントフック要求のステータスを成功と失敗のいずれかで表示します。

関連項目

イベントフックの追加

エンドポイントの確認