Webhook API連携

Webhook API連携を利用すると、GRiXで取得した資料閲覧データや顧客行動データを、外部システムへ自動連携できます。
SalesforceなどのCRMだけでなく、Webhookを受け取れる外部システムであれば連携先として設定できます。

Webhook API連携でできること
Webhook API連携を設定すると、GRiX上で取得した以下のようなデータを、指定したWebhook URLへ送信できます。
資料URLを発行した営業ユーザー情報
資料URL発行時に入力した会社情報
閲覧されたコンテンツ情報
閲覧者のメールアドレス・氏名などの認証フォーム情報
閲覧時間
閲覧割合
閲覧度スコア
HOT / MEDIUM / COLD の判定
ダウンロード有無
AIチャット・問い合わせ・Web会議予約などの利用有無
認証フォームでの離脱有無
よく閲覧されたページ
よく閲覧されたINDEXカテゴリ
会社分析画面・詳細分析画面・URL管理画面のURL

利用できるユーザー
Webhook API連携の設定は、管理者ユーザーのみ利用できます。
管理者以外のユーザーには、Webhook設定画面は表示されません。

Webhook設定画面を開く
「設定」画面から「Webhook」を開きます。

Webhookの新規作成
Webhookを設定するには、以下の項目を入力します。
_
項目説明
Webhook名管理用のWebhook名です。連携先や用途がわかる名前を入力してください。
Webhook URL連携先システムが指定するエンドポイントURLを入力してください。
Secret KeyGRiXが自動生成する認証用キーです。連携先システム側でリクエスト検証に利用できます。
WebhookステータスWebhookを有効化するか、無効化するかを設定します。
必須項目を入力すると、「保存」ボタンが押せるようになります。

Secret Keyについて
Secret Keyは、Webhookリクエストの検証に利用できる認証用キーです。
GRiX側で自動生成されます。
Webhook設定画面では、Secret Keyは通常 *** のようにマスク表示されます。
利用できる操作:
_
操作説明
表示マスクされているSecret Keyを表示します。
コピーSecret Keyをクリップボードにコピーします。
再発行新しいSecret Keyを発行します。

Secret Keyを再発行する場合の注意点
Secret Keyを再発行すると、以前のSecret Keyは利用できなくなります。
連携先システム側でSecret Keyを使ってリクエスト検証を行っている場合は、再発行後のSecret Keyに更新してください。
更新しない場合、連携先システム側でWebhookリクエストが拒否される可能性があります。

Webhookステータス
Webhookごとに、有効・無効を切り替えることができます。
_
ステータス説明
有効Webhook送信が行われます。
無効Webhook送信は行われません。
一時的に連携を停止したい場合は、Webhookを削除せずに「無効」にしてください。

複数Webhookの設定
Webhookは複数作成できます。
複数のWebhookを設定することで、GRiXのデータを複数の外部システムへ送信できます。
例:
Salesforceへ連携
自社データベースへ連携
MAツールへ連携
通知システムへ連携

登録済みWebhookの確認
「過去のWebhookを表示する」から、登録済みのWebhook一覧を確認できます。
一覧では以下の情報を確認できます。
_
項目説明
Webhook名登録したWebhook名です。
ステータス有効・無効の状態です。
最終更新日Webhook設定が最後に更新された日時です。
編集Webhook設定の編集・削除ができます。


Webhookの編集
登録済みWebhookの「編集」から、Webhook設定を変更できます。
変更できる項目:
Webhook名
Webhook URL
Webhookステータス
Secret Keyの再発行
編集後は「保存」を押してください。

Webhookの削除
不要になったWebhookは削除できます。
削除したWebhookには、以後データは送信されません。

送信される主なデータ
Webhookでは、GRiXで取得した閲覧・行動データが送信されます。
_
項目説明
seller_email資料URLを発行した営業ユーザーのメールアドレスです。
company_name資料URL発行時に入力した会社名、および会社IDです。
contents資料URLに紐づくコンテンツ名、およびコンテンツIDの一覧です。
contents_url資料閲覧URLです。
preview_urlプレビューURLです。
buyer_email閲覧者のメールアドレスです。閲覧者認証フォームが有効な場合は、閲覧者が入力したメールアドレスが表示されます。認証フォームが無効な場合は、Unknownとして表示される場合があります。
spent_time資料の閲覧時間です。
percent_viewed資料の閲覧割合です。
percent_feel閲覧度スコアです。1〜100の数値で表示されます。
feel_status閲覧度スコアをもとにした HOT / MEDIUM / COLD の判定です。
view_time資料URLの閲覧回数です。
is_download資料がダウンロードされたかどうかを yes / no で表示します。ダウンロード許可が無効な場合は N/A になります。
is_aichatAIチャットが利用されたかどうかを yes / no で表示します。
is_surveyアンケートに回答されたかどうかを yes / no で表示します。
is_inquiry問い合わせが利用されたかどうかを yes / no で表示します。
is_webmeetingWeb会議予約が利用されたかどうかを yes / no で表示します。
is_otherresource関連情報が利用されたかどうかを yes / no で表示します。
is_statuscheck現況チェックが利用されたかどうかを yes / no で表示します。
is_url_shareURLが共有されたかどうかを yes / no で表示します。
start_date資料URLへのアクセス開始日時です。
end_date資料URLへのアクセス終了日時です。
download_date資料がダウンロードされた日時です。
download_contentsダウンロードされたコンテンツ名です。
buyer_name閲覧者認証フォームで入力された氏名です。
buyer_phone閲覧者認証フォームで入力された電話番号です。
buyer_job_title閲覧者認証フォームで入力された役職です。
buyer_address閲覧者認証フォームで入力された住所です。
buyer_postal_code閲覧者認証フォームで入力された郵便番号です。
buyer_company閲覧者認証フォームで入力された会社名です。
buyer_department閲覧者認証フォームで入力された部署名です。
buyer_customカスタム項目のラベルと回答の一覧です。
is_auth_modal_drop閲覧者が認証フォームで離脱したかどうかを yes / no で表示します。閲覧ユーザーの認証設定が無効な場合は N/A になります。
most_viewed_page最も閲覧されたページ番号です。複数コンテンツが紐づく場合は、コンテンツ名もあわせて表示されます。
most_viewed_index_category最も閲覧されたINDEXカテゴリ名です。複数コンテンツが紐づく場合は、コンテンツ名もあわせて表示されます。
detailed_analysis_URL詳細分析画面のURLです。
company_analysis_URL会社分析画面のURLです。
url_management_URLURL管理画面のURLです。


Webhook受信側での確認事項
Webhookを利用する場合、連携先システム側でWebhookリクエストを受け取れるように設定してください。
確認すべき項目:
Webhook URLが正しいか
POSTリクエストを受け取れるか
JSON形式のリクエストボディを処理できるか
必要に応じてSecret Keyでリクエストを検証できるか
連携先システム側で必要なヘッダーや必須項目があるか
連携先システムによって、必要なヘッダーや必須項目が異なる場合があります。
事前に連携先システムの仕様をご確認ください。

テスト接続について
現在、GRiXのWebhook設定画面には汎用的なテスト接続機能はありません。
Webhookの受信条件は連携先システムごとに異なり、特定のヘッダーや必須フィールドが必要になる場合があるためです。
Webhook設定後は、連携先システム側でリクエストの受信状況をご確認ください。

よくある質問
Q. WebhookはSalesforce専用ですか?
A. いいえ。Webhookを受け取れる外部システムであれば、Salesforce以外のシステムにも連携できます。

Q. SalesforceのManaged Packageは必要ですか?
A. Webhook API連携では、SalesforceのManaged Packageを利用せずに連携できます。
ただし、Salesforce側でWebhookを受け取る仕組みや、受信データを処理する設定が必要です。

Q. Webhookは複数作成できますか?
A. できます。複数のWebhookを作成し、複数の外部システムへデータを送信できます。

Q. Webhookを一時停止できますか?
A. できます。Webhookステータスを「無効」にすると、そのWebhookへの送信を停止できます。

Q. Secret Keyはどこで確認できますか?
A. Webhook設定画面で確認できます。
通常はマスク表示されていますが、「表示」ボタンを押すと実際の文字列を確認できます。

Q. Secret Keyを再発行するとどうなりますか?
A. 新しいSecret Keyが発行され、以前のSecret Keyは利用できなくなります。
連携先システム側でSecret Keyを利用している場合は、必ず新しいSecret Keyに更新してください。

Q. 認証フォームを設定していない場合、buyer_emailはどうなりますか?
A. 閲覧者認証フォームが有効でない場合、閲覧者のメールアドレスを取得できないため、 Unknown として表示される場合があります。

Q. ダウンロードを許可していない場合、is_downloadはどうなりますか?
A. ダウンロード許可が無効な場合、 is_download N/A になります。

Q. 認証フォームを設定していない場合、is_auth_modal_dropはどうなりますか?
A. 閲覧者認証フォームが無効な場合、 is_auth_modal_drop N/A になります。

Q. Webhookのテスト接続はできますか?
A. 現在、GRiX画面上での汎用的なテスト接続機能はありません。
Webhook設定後、連携先システム側でリクエストの受信状況をご確認ください。