Webhook

Webhook（ウェブフック）とは何ですか？

ウェブ開発におけるWebhook（ウェブフック）とは、カスタムコールバックを使用してウェブアプリケーションの動作を拡張または変更する手法のことです。これらのコールバックは、必ずしも元のアプリケーションと提携していないサードパーティのユーザーや開発者によって維持・管理される場合があります。

QuestionProは、インカミング（受信）とアウトゴーイング（送信）の両方のWebhookをサポートしています。Webhookは、アンケートの開始前、アンケートの途中（質問の前または後）、またはアンケートの完了後に実行させることができます。

Webhooks-advanced-helpfile.mp4

クリックして動画をダウンロード

インカミングWebhook（Incoming Webhooks）とは何ですか？

インカミングWebhookは、外部ソースからアンケート内にデータを取得するためのシンプルな方法です。

アウトゴーイングWebhook（Outgoing Webhooks）とは何ですか？

アウトゴーイングWebhookは、アンケートデータを外部ソースに送信するために使用されます。JSONペイロードを伴う標準的なHTTPリクエストを利用します。

Webhookの設定方法を教えてください。

Webhookを作成する手順：

Webhookを設定したいアンケートを選択します。

移動先： 外部連携（Integrations） >> Webhooks

新規Webhookの追加（Add New Webhook） ボタンをクリックします。

Webhookの説明（Description）を入力し、Webhookの作成（Create Webhook） ボタンをクリックします。

設定ページに移動したら、トリガーイベントを選択してWebhookを実行するタイミングを指定します。

Webhookは、アンケート開始前、質問の後、アンケート内のページの移行時、「保存して続行（Save and Continue）」ボタンのクリック後、およびアンケート完了後に実行させることができます。

注：「質問の後（After Question）」をトリガーとした場合、実際にWebhookが実行されるのはアンケートの完了時になりますが、送信されるのはその質問までに取得されたデータのみであり、全体の回答データは送信されません。質問の直後に即座にWebhookを実行させたい場合は、その質問の後に手動で改ページ（ページブレイク）を追加する必要があります。

アンケート完了後をトリガーとして選択した場合、Webhookを実行するための詳細な条件を設定することも可能です。
条件（必要な場合）を設定し、次へ（Next） をクリックします。

トリガー条件を選択した後は、API呼び出しに必要なデータを指定します：

メソッド（Method）： 呼び出しに使用するHTTPメソッド（GET, POSTなど）。
API URL： API呼び出しを行うエンドポイントのURL。

認証タイプ（Authorization type）： 認証タイプを選択し、必要に応じて資格情報を追加します。外部ソースの要件に応じて、資格情報を ヘッダー（header） または パラメータ（parameters） のいずれかに追加することを選択できます。

リクエストヘッダー（Request Header）： リクエストのヘッダーセクションを構成するHTTPヘッダーフィールド。

リクエストJSON（Request JSON）： APIが必要とするペイロード（データ）。「回答を挿入（Insert Response）」ボタンを使用して、アンケートの回答内容をリクエストJSON内に挿入することもできます。

上記の詳細を入力したら、テスト実行（Test Run） ボタンをクリックして、期待通りの出力が得られるか確認します。得られない場合は、APIリクエストデータを修正して再試行してください。出力内容に問題がなければ、次へ（Next） をクリックします。

データマッピングの手順は、主にインカミングWebhookで必要となります。外部ソースから取得したデータは、変数にマッピングして保存できます。これらの変数は、回答者の回答と一緒に保存されるカスタム変数とは異なることにご注意ください。データ変数へのマッピングが不要な場合は、そのまま進めて 保存（Save） をクリックできます。

個々のJSONキーを特定の変数に割り当てることで、データを変数にマッピングできます。変数は必要に応じていつでも追加および削除できます。

マッピングが設定されると、収集したデータをアンケート内に次のコードを使って表示できます： ${code}

最後に、Webhookを本番環境で稼働させるには、トグルスイッチを有効にしてWebhookをアクティブ（Active）にします。

アウトゴーイングWebhookにデータを渡すにはどうすればよいですか？

アウトゴーイングWebhookの場合、リクエストJSONにカスタム変数を追加することで、カスタム変数内に収集されたデータを外部のウェブサービスに送信できます。

データ置換変数タグ

リクエストJSON内で対応するカスタム変数のデータを取得するには、以下のタグを使用できます：

カスタム変数 1: ${custom1}

カスタム変数 2: ${custom2}

カスタム変数 3: ${custom3}

カスタム変数 4: ${custom4}

カスタム変数 5: ${custom5}

カスタム変数 N: ${customN}

Webhookの実行が成功したか失敗したかを確認する方法はありますか？

QuestionProは各Webhookのログ機能を提供しており、そのWebhookによって呼び出されたAPIの詳細、ペイロード、およびエンドポイントからのレスポンスを確認できます。ログにアクセスするには、特定のWebhookの設定画面を開いて ログ（Logs） をクリックします。そのWebhookによって行われたリクエストの一覧が表示され、IDをクリックすると特定の呼び出しの詳細を確認できます。

また、アンケート完了後（After Survey） イベントでデータ送信に失敗したアウトゴーイングコールがある場合は、失敗したAPI呼び出しの横に「手動再試行（Manual Retry）」ボタンが表示され、いつでもクリックしてデータをAPIエンドポイントに再送信できます。複数のWebhookを選択して一括で再試行することも可能です。なお、その他のトリガーイベントでは再試行メカニズムはサポートされていません。

すべてのトリガーイベントで条件設定（ロジック）はサポートされていますか？

いいえ。現在のところ、条件設定がサポートされているのは アンケート完了後（After Survey） イベントのみです。

条件設定でサポートされている質問タイプは何ですか？

現在、単一選択（Select one）、複数選択（Select many）、ドロップダウンメニュー（Drop-down menu）、および単一記述（Single row text）をサポートしています。

アンケート内で変数のデータを表示するにはどうすればよいですか？

アンケート内で ${customN} のような変数の値を表示したい場合は、単純に ${code} を使用して表示させることができます。あるいは、Webhookのデータマッピングセクションで設定したアンケートレベルのカスタム変数マッピングをそのまま適用するか、その設問の前に改ページ（ページブレイク）を追加することでも対応可能です。

ライセンス

この機能は、次のライセンスで使用できます。

Team Edition and Research Edition

この記事は役に立ちましたか？

はいいいえ

申し訳ございません

どうしたら改善できますか？

提出