Webhook機能について – CREATIVE SURVEY ヘルプ

概要

連携したいサービスの仕様に合わせてリクエスト内容を柔軟にカスタマイズしwebhookを送信できる機能です。
※本機能をご利用いただくにはWebhookやJSONの知識が必要です。

設定方法

1.公開設定→回答完了後アクションの「Webhookを送信する」を選択
Screenshot 94.png

2.「Webhook詳細設定」をクリックし、タイトルを入力
最大255文字まで入力可能で、webhook設定を複数設定した際に判別するためのラベルです。
送信されるリクエストに影響のあるものではありません。
※未設定でも可
スクリーンショット 2023-11-21 15.03.27.png

3.Webhook詳細設定モーダルにて各種設定を行う

■設定例（content-Type：「application/json」の場合）
Screenshot 389.png

詳細の設定

URL：リクエストの送信先URL
Method：送信するHTTPリクエストのメソッド
- 「POST」 or 「PUT」 or 「PATCH」を選択可能。
Header：送信するHTTPリクエストのheader情報、初期値は{"Content-Type":　"application/json"}。
- リクエスト可能なContent-Typeは下記の通りです。
  - application/json
  - application/x-www-form-urlencoded
  - multipart/form-data
  - multipart/byteranges
Body：送信するHTTPリクエストのbody情報を入力。初期値は {}。
- 置換テキスト機能で設定した変数が画面右に表示されますので、コピーしてBody内に記述することで回答値を送信することができます。
  - Headerに記載したリクエスト形式（Content-Type）が「application/json」の場合
    - Body記述する際にはダブルクォーテーション"で囲う必要があります。
      - 例：$${{answer1}}$$→"$${{answer1}}$$"
    - 「key1」の値としてSTEP1の回答値、「key2」の値としてSTEP2の回答値、「key3」の値としてSTEP3の回答値として送信したい場合
```
{
"key1":"$${{answer1}}$$",
"key2":"$${{answer1}}$$",
"key3":"$${{answer1}}$$"
}
```
  - Headerに記載したリクエスト形式（Content-Type）が「application/x-www-form-urlencoded」の場合
    - key1=value1&key2=value2のような形で記述します。
    - 「key1」の値としてSTEP1の回答値、「key2」の値としてSTEP2の回答値、「key3」の値としてSTEP3の回答値として送信したい場合
```
key1=$${{answer1}}$$&key2=$${{answer2}}$$&key3=$${{answer3}}$$
```
      ※json形式とは異なり "で囲う必要はありません
      ※詳細な記載方法は連携するサービスによって異なります。
  - 置換テキストの変数を利用して数値型のデータを送信する場合
    - 例：$${{answer1}}$$→$$NUMBER({answer1})$$ のような形で指定します。
    - 置換テキストの変数を数値型として利用可能な設問タイプは下記の通りです。
      - テキスト入力
      - NPSタイプ
      - 固定回答タイプ
      - スライドバー
      - マルチスライドバー

　　置換テキストの変数の利用についての注意事項

- 置換テキスト機能で設定した変数を利用いただけます。
- $$及び, が入っている置換テキストは利用できません
- 下記の設問タイプを指定している置換テキストは、Webhookの変数として利用できません
  - 開始ステップ
  - 提示ステップ
  - 画像拡大ステップ
  - エリアマッピング
  - クリッツポイント
  - 複数クリッツ
  - 最終ステップ
    
    ■置換テキストの設定例

4.保存ボタンをクリック

設定に不備がある場合は保存ボタンをクリックできません。
また、不備のある入力欄にはエラーメッセージが表示されます。
※エラーメッセージが表示されている場合はエラー箇所が改善されるまで保存操作ができません。
その状態で現状の設定を保存したい場合は、メモアプリなどにコピーをとっておくなどでご対応ください。

■エラーメッセージの表示例
Screenshot 390.png

アップロードタイプで取得したファイルデータの外部連携について

アップロードタイプで取得したファイルデータを外部システムに連携したい場合は下記のヘルプをご参考ください。
アップロードタイプで取得したファイルデータの外部連携について

注意事項

これまで提供しておりましたWebhook（レガシー）機能は引き続きご利用いただけますが、利用は非推奨となります。レガシー版をご利用のユーザー様は適時上記Webhook機能への切り替えをお願い致します。

　最終更新日：2024/8/29

概要

設定方法

アップロードタイプで取得したファイルデータの外部連携について

注意事項

Reccomended Contents