Zoho PageSenseでのWebhookの設定

Zoho PageSenseでのWebhookの設定

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Webhookを使用すると、対応するイベントが発生するたびに、Zoho PageSenseから外部のアプリケーションやサーバーにデータを送信できます。これにより、PageSenseを既存のシステムと連携させ、コンバージョンやフォーム送信のデータを使用してワークフローを自動化できます。
たとえば、訪問者が目標を達成したときにコンバージョンデータをバックエンドに送信したり、ポップアップ画面のフォーム送信データを別のシステムに送信して追加の処理を行ったりできます。
メモメモ:現在、WebhookはZoho PageSenseの目標達成とポップアップ画面のフォーム送信に対応しています。その他の機能への対応は、今後の更新で追加される予定です。

Webhookの作成  

PageSenseでWebhookを作成するには:
Zoho PageSenseのアカウントにログインし、[設定]→[サービスに接続する]→[Webhook]に移動します。

[新規Webhook]をクリックし、名前を入力します。必要に応じて、用途を示す説明も入力します。

データを受信するアプリケーションまたはサーバーのWebhookのURLを入力します。

エンドポイントで必要な認証方法を設定します。

[テスト要求を送信する]をクリックして、エンドポイントが要求を受信できるか確認し、Webhookを保存します。

Webhook認証の設定  

PageSenseは、Webhookで次の認証方法に対応しています。受信側のエンドポイントの認証要件に一致する方法を選択します。
HMAC


認証方法としてHMAC(ハッシュベースのメッセージ認証コード)を推奨します。サーバー側で、要求がPageSenseから送信されたものであることと、署名された内容が改ざんされていないことを検証できます。
HMACを設定するには:
  1. 認証の種類として[HMAC]を選択します。
  2. 生成されたシークレットキーをコピーし、安全に保管します。
  3. 受信サーバーで、シークレットキーを使用して、 X-PageSense-Signatureヘッダー内の送信済みの署名を検証するように設定します。
  4. 検証結果に基づいて、要求を受け入れるかどうかを判断します。
PageSenseはシークレットキーを使用して各要求に署名し、その署名をX-PageSense-Signatureヘッダーに含めます。サーバー側で、対応する署名検証ロジックを実装する必要があります。
重要:シークレットキーは機密情報として管理してください。公開の場で共有したり、クライアント側のコード内に露出させたりしないでください。

認証なし
受信エンドポイントで認証が不要な場合は、[認証なし]を選択します。[認証の種類]ドロップダウンから[認証なし]を選択します。追加の認証情報は不要です。
この選択肢は、エンドポイントが未認証の要求を受け入れる設計になっており、関連するセキュリティリスクを検討済みの場合にのみ使用してください。




ベアラートークン
受信エンドポイントが認証にベアラートークンを使用する場合は、[ベアラートークン]を選択します。
設定するには:
  1. 認証の種類として[ベアラートークン]を選択します。
  2. トークンを[トークン]項目に入力します。
  3. Webhookを保存します。
PageSenseは、次の形式でAuthorizationヘッダーにトークンを設定して送信します:
Authorization: Bearer <token>



APIキー
受信エンドポイントで要求ヘッダー内のAPIキーが必要な場合は、[APIキー]を選択します。
設定するには:
  1. 認証の種類として[APIキー]を選択します。
  2. 必要なヘッダー名を[キー名]に入力します。
  3. 対応するAPIキーを[キーの値]に入力します。
  4. Webhookを保存します。
PageSenseは、指定された名前と値を使用して、APIキーをヘッダーとして送信します。


ベーシック認証
受信エンドポイントがユーザー名とパスワードによる認証を使用する場合は、[ベーシック認証]を選択します。
設定するには:
  1. 認証の種類として[ベーシック認証]を選択します。
  2. ユーザー名を[ユーザー名]に入力します。
  3. パスワードを[パスワード]に入力します。
  4. Webhookを保存します。
PageSenseは、ベーシック認証に必要な認証ヘッダーに認証情報を設定して送信します。


 Webhookのテスト  

設定したエンドポイントがPageSenseからの要求を受信できるかどうかは、[テスト要求を送信]の選択肢で確認できます。
テスト要求を送信する前に、次の事項を確認してください:
  • 有効なWebhookのURLを入力している。
  • 適切な認証方法を選択している。
  • 認証が必要な場合は、必要な認証情報を入力している。
  • 受信する要求を受け入れるようにエンドポイントを設定している。
テスト要求が失敗した場合は、URL、認証の詳細、エンドポイントの設定を検証してから、再試行してください。

Webhookが実行されるタイミング  

現在、PageSenseでは次のイベントでWebhookを利用できます:
  • 目標達成:訪問者が設定された目標を達成したときに、データを送信します。
  • ポップアップ画面のフォームの送信:訪問者が対応するポップアップ画面のフォームを送信したときに、データを送信します。
これらのWebhookを使用すると、関連するイベントデータを自社のシステムに渡して、追加の処理やワークフローの自動化に活用できます。今後の更新で、PageSenseのその他の機能にも対応する予定です。

よくある質問  

PageSenseのすべての機能でWebhookを使用できますか?
現時点では使用できません。現在、Webhookは目標達成とポップアップ画面のフォームの送信に対応しています。今後の更新で、その他の機能にも対応する予定です。

どの認証方式を選択すればよいですか?
受信側のエンドポイントが対応している認証方式を選択してください。サーバーで要求の署名を検証できるため、HMACを推奨します。エンドポイントでBearerトークン、APIキー、または基本認証が必要な場合は、PageSenseで対応する選択肢を選択してください。

自社のサーバーにWebhookのデータを送信できますか?
はい。サーバーのWebhookエンドポイントのURLを入力し、必要な認証方式を設定してください。

テスト要求が失敗した場合は、どうすればよいですか?
WebhookのURLが有効でアクセス可能であること、選択した認証方式がエンドポイントの要件と一致していること、認証情報が正しいことを確認してください。また、サーバーが要求を受信できるように設定されていることも確認してください。

今後、WebhookはPageSenseのその他の機能にも対応しますか?
はい。今後の更新で、対応する機能を追加する予定です。現在対応しているイベントは、目標達成とポップアップ画面のフォームの送信です。

 



このドキュメントでは、各手順をわかりやすく説明しています。さらにサポートが必要な場合やご質問がある場合は、お気軽にお問い合わせください。お問い合わせ先: support@zohopagesense.com - いつでもサポートいたします。