お困りですか？

Webフック

最終更新:

概要

Webhookは、特定のイベントが発生するとリアルタイムで通知を他のサービスにプッシュアウトします。これは、情報を取り込むためにリクエストを必要とするAPIとは異なります。APIで接続されているサービスの多くは、各リクエストに15分（またはそれ以上）の間隔を要します。Webhookはリクエストを必要とせず、その情報をすぐに送信します。認知度の向上や顧客とのコミュニケーションのために、リアルタイムでの通知が必要な場合には特に有効です。

通知をプッシュすることができるイベントは以下のとおりです。

  • ガイドを表示する
  • ウェブトラックイベントを受信する
  • NPSアンケート（表示/提出）
  • アンケート調査（表示/提出）
  • アプリ内で訪問者が最初に表示されたとき
  • アプリ内でアカウントが最初に表示されたとき
  • （親アカウントが有効なお客様の場合）アプリ内で新しい親と子の組み合わせが表示されたとき

Webhookは、Pendoで発生したリアルタイムのイベントに基づいて、ビジネス全体のワークフローを推進することができます。たとえば、次のようなことが可能です。

  • イベント情報をSegment.comなどのプロバイダーに送信し、他のシステムにルーティングする
  • AWS LambdasやZapierのような他のプラットフォームでワークフローを動かす
  • Zendesk Sunshineのように、Pendoイベントを使ってCRMプラットフォームにリアルタイムでアップデートを送信する
  • イベントをサードパーティのSIEMプロバイダーに送信し、リアルタイムで分析する
  • 監査やコンプライアンスのために管理イベントをアーカイブする

 

要件

Webhookを設定し、管理するには、Pendo Adminの権限が必要です。

AdminUser.png

投票調査およびNPSイベントを使用するには、エージェントバージョン2.33.0以上が必要です。

 

Webhookの種類

Webhookには2種類あります。

Segment.com Webhook

Segment.comとの連携により、Segment.com Webhookを作成して、Segmentの推奨フォーマットでイベントを送信することができます。

URL Webhook

Webhookは通常、URLを介してイベント情報を送信します。Webhookを受け付けるほとんどのプラットフォームが、URLを使用します。

Webhook通知を送信するプラットフォームでは、各Webhookに固有のURLが生成されます。

 

Webhookへのアクセス

Webhookは、［設定（Settings）］の［インテグレーション（Integration）］セクションにあります。

mceclip0.png

［インテグレーション（Integration）］ヘッダーの下にある、［Webhook（Webhooks）］タブをクリックすると、すべてのアクティブまたは非アクティブなWebhookが表示されます。

whtab.png

 

Webhookの作成

［+ Webhookを追加（+ Add a Webhook）］をクリックして、新しいWebhookを作成します。

 _wh.png

Webhookの［設定（Settings）］でWebhookの詳細を追加します。

  • Webhookに名前をつける：わかりやすい名前にします。Webhookの宛先と、どのデータが送られるのかを記載します。
  • 種類を選択する：Segment.comまたはURL
  • 書き込みキーまたはURLを入力します

AddWebhook.png

 

Segment.com Webhookの作成

このWebhookタイプには、Segment.comのアカウントが必要です。

セグメントのソースとしてPendoを設定し、書き込みキーを取得します。

［概要（Overview）］>［インストール（Installation）］のセクションから、［書き込みキー（Write Key）］をPendo Webhookにコピーします。セグメントの書き込みキーの詳細については、こちらをご覧ください。

SegmentWH.png

 

URL Webhookの作成

Pendo Webhookを受け取ったプラットフォームは、Pendoが通知をプッシュするための固有のURLを生成します。WebhookのURLを入手したら、Pendoで設定を続けます。

送信先URLを追加します。イベントがトリガーされると、このURLに情報が送信されます。

［テスト（Test）］をクリックしてサンプルのペイロードを送信し、送信先がイベントのペイロードを受け入れるかどうかを検証することができます。

［シークレット（Secret）］の値を使用して、URLで受信した情報が信頼された正しいソースからのものであることを検証することができます。シークレットには、特殊文字を含む任意の値を使用でき、単純なものからセキュリティプロトコルで要求されるような複雑なものまで設定できます。

urlwh.png

警告：Webhookのイベント情報には、お客様のインストールやデータのマッピングによって、個人を特定できる情報（PII）が含まれている場合があります。Webhookのテストや有効化を行うときは、必ず信頼できる宛先やサービスを使用するようにしてください。

 

イベントカテゴリーのタイプ

Webhookで送信するイベントカテゴリーを選択します。

mceclip0.png

 

Webhookの有効化と無効化

Webhookはデフォルトでは無効になっており、データを送信するには有効にする必要があります。

スライダーを切り替えると、データの送信が開始されます。

enablewh.png

Webhookのスライダーが緑色の場合は、データ送信が有効になっています。

activewh.png

スライダーを戻してWebhookを非アクティブにすることで、いつでもデータの送信を停止できます。

 

Webhookの編集と削除

Webhookの上にカーソルを置くと、編集と削除のボタンが表示されます。

編集ボタンで、［Webhookの設定（Webhook Setting）］ページが表示され、Webhookに変更を加えることができます。

editdeletewh.png

削除ボタンは、Webhookを削除するかを確認した後、データの送信を停止し、Webhookを永久に削除します。Webhookの設定を失わずにデータを停止するには、［Enabled（有効化）］スライダーを使用してWebhookを無効にします。

deltewhw.png

 

よくある質問

エラーが発生した場合、Pendoはイベントの送信を再試行しますか？

429エラーまたは500～599の範囲のエラーメッセージを受信した場合、Pendoは最大5回まで再試行します。

APIバルクメタデータエンドポイント経由で訪問者やアカウントが最初に作成された場合、イベントを受信することはできますか？

いいえ、APIで訪問者やアカウントを作成しても、アプリ内で訪問者が特定されるまでWebhookはトリガーされません。

除外された訪問者からのイベントを受信することはできますか？

いいえ。訪問者が除外されている場合、Pendoは宛先にイベントを送信しません。

Webhookの送信先としてSlackを使用できますか？

いいえ。SlackをWebhookの送信先として使用するには、POSTが特定のフォーマットであることが求められます。Zapierなどのツールを使って、Pendoが送信するJSON本文をSlackが期待するフォーマットに変換する必要があります。

 

関連記事