OOOPEN LabのクイズデータをWebhookで連携する方法

OOOPEN Labのクイズやインタラクティブプロジェクトの回答データ・結果を、Webサイト、CRM、Googleスプレッドシートなどの社内システムへ自動送信したい場合は、APIキーとWebhookを利用できます。

見込み顧客の自動分類やデータ処理の効率化に利用できます。ここでは設定方法、送信されるデータ、トリガーのタイミング、セキュリティ上の注意を紹介します。

目次

• Webhookを有効にする方法
• 送信されるデータ
• 送信されないデータ
• 推奨するセキュリティ対策

Webhookを有効にする方法

1. 有料プランの利用期間中にこの機能を利用できます。プランの選び方も確認してください。
2. 「プレイヤープロフィール」から開発者向けを開きます。
3. 初回は新しいAPIキーを発行します。
4. APIキーの発行後、Webhookイベントを設定します。
5. 「開始」イベントは参加者が質問ページに入った時、「完了」イベントは結果ページに到達した時に送信されます。
6. 設定したURLへ、条件を満たすたびにPOSTリクエストが送信されます。

JSONペイロードの例

{
  "data": {
    "answerId": "o1VepeqjgSbe6XxeJlZs",
    "quizId": "nvCwKZUvGw43KTrMth3V",
    "startedAt": "2024-04-11T08:44:10.782Z",
    "ref": { "id": "gI11io", "label": "Channel Name" },
    "utm": { "campaign": "", "id": "", "source": "" }
  }
}

送信されるデータ

イベントに応じて、回答ID、プロジェクトID、開始・完了時刻、流入元、UTM、回答内容、結果などが送信されます。実際のペイロードを受信環境で確認し、必要な項目だけを保存してください。

送信されないデータ

設定されていない項目、参加者が入力していない項目、または権限上送信できない情報は返りません。Webhookの値を前提に重要な処理を行う場合は、欠損値を安全に扱ってください。

推奨するセキュリティ対策

• 受信URLはHTTPSを使用する。
• APIキーを公開ページやクライアントコードに置かない。
• 受信側でリクエストを検証し、不要な個人情報を保存しない。
• 失敗時の再送、ログ、問い合わせ手順を用意する。