Webhookを使用して、WalkMeイベントデータをサードパーティーシステムに送信する方法
概要
Webhook（別名コールバック）を作成したり、カスタマイズしたりして、特定の結果をトリガーするために使用するサードパーティシステムにWalkMeのイベントデータを送信することにより、リアルタイムでデータに基づいた意思決定を行ったり、その場で体験したりすることができます。
イベント自体がトリガーするWebhookなら、任意のシステムにリアルタイムのWalkMeイベント情報を配信できます。 つまり、 遅延なく情報を受け取ることにより、チームは即時性が重要な情報に対して即座に対応できるようになります。
Webhookは分析／BIツールにWalkMeイベントデータを追加したり、サードパーティのAPIをトリガーしたりすることに使用できます。 これでユーザーがShoutOutをクリックすると、メールマーケティングシステムのメールリストに追加したり、NPSアンケートに回答した際にSlackチャネルに即座に通知を送信したりすることができます。 Webhookを使用すると、研究開発の手間をかけずにワークフローにWalkMeを直接構築できます。
Webhookの詳細については、以下の記事を参照してください。
ユースケース
- WalkMeイベントデータを分析BI ツールに統合する
- ユーザーがWalkMeを利用した際に、メールリストにユーザーを追加する
- ユーザーがアクションを実行した後に、即座に通知をSlackチャネルに直接送信する
Webhookを使用してWalkMeデータを送信する手順
-
- インサイトの統合ページ（insights.walkme.com）に移動します
- リアルタイム統合でWebhooksをクリックします
- + NEW WEBHOOKをクリックします
- webhookに名前とCリックを与える
- webhookイベントの詳細を入力します
- イベントドロップダウンからWalkMeイベントを選択します
- オプション条件を追加します
- 詳細>ドロップダウンセクションでは、選択したイベントのプロパティを指定できます
- 宛先システムが期待する属性に合わせてプロパティの名前を変更できます。
- 名前を変更しない場合、これらはWebhookコールで受け取ることになる値です。
- + ADD PROPERTYボタンを使用して、Webhookコールと一緒に送信する追加の静的プロパティを設定することもできます。
- プロパティ名にスペースは使用できません。
- 「_」またはcamelCaseを使用して単語を区切ることをお勧めします。
- ［Continue（続行）］をクリックします。
- webhookの宛先詳細を入力します
- 宛先プラットフォーム名を入力します
- これは、イベントデータを送信したいサードパーティプラットフォームです。例：ヒープ分析、ミックスパネル、Google分析
- リクエストタイプと宛先URLを入力します
- これらは、webhookコールを実行する方法と場所を指定します
- これらの詳細は、宛先システムのAPIドキュメントに記載されています
- オプションの認証タイプを選択します
- 宛先システムのAPIドキュメントを参照して、これが必要かどうかを確認します
- WalkMeは以下の認証方法に対応しています。
- 認証なし
- ベアラートークン：トークンが必要です
- 基本的な認証：ユーザー名とパスワードが必要です
- OAuth 2.0
- + ADD PROPERTYボタンを使用して、オプションのヘッダーを入力します
- これらは、webhookコールを実行するために必要な値です
- 宛先システムのAPIドキュメントに相談して、これが必要かどうかを理解します
- 宛先プラットフォーム名を入力します
- ［Save（保存）］をクリックします。
- エディタで設定を公開するように求められます
- このステップは、最初に作成するWebhookにのみ必要です
- 詳細については、以下の記事を参照してください：グローバル設定を公開する方法
- インサイトの統合ページ（insights.walkme.com）に移動します
webhookが正常に設定されたことを確認するには、以下の手順に従ってください。
- アプリケーションを入力します
- webhookが追跡しているイベントを実行します
- 設定した宛先システムがwebhookコールを受信し、希望の結果を実行することを確認してください
-
ヒント：宛先ページで宛先を管理できます。
利用可能なイベント一覧
以下の表には、Webhookイベントを作成する際に利用可能なすべてのオプションが表示されています。
| グループ | Name | 説明 |
Smart Walk-Thru |
スマートウォークスルーステップが再生されました | 特定のスマートウォークスルーステップでイベントを受信します |
| スマートウォークスルーゴールに到達 | スマートウォークスルーに設定したゴールでイベントを受信します | |
| スマートウォークスルーが開始されました | スマートウォークスルーがユーザーに表示されたイベントを受信します | |
| スマートウォークスルーに失敗しました | 開始に失敗したスマートウォークスルーのイベントを受信します | |
|
Launcher |
Launcherがクリックされました | Launcherをユーザーがクリックしたイベントを受信する |
|
Onboarding |
オンボーディングタスクが完了しました | オンボーディングタスクが完了したイベントを受信する |
|
シャウトアウト |
シャウトアウトアクションがクリックされました | ユーザーがシャウトアウトをクリックしたイベントを受信する |
| シャウトアウトが閉じられました | シャウトアウトが閉じられた場合にイベントを受信する | |
| シャウトアウトの目標を達成しました | シャウトアウトに設定したゴールを含むイベントを受信する | |
| シャウトアウト表示 | ユーザーにシャウトアウトが表示されたイベントを受信する | |
|
スマートチップ |
スマートチップメッセージが表示されました | スマートチップメッセージがユーザーに表示されたイベントを受信する |
| スマートチップの検証にエラーが発生しました | スマートチップ検証ルールがトリガーされたイベントを受信する | |
|
アンケート |
アンケートの質問に回答しました | ユーザーが特定の質問に回答したイベントを受信する |
| アンケートが拒否されました | ユーザーがアンケートを開始したものの送信しなかったイベントを受信する | |
| アンケートが送信されました | ユーザーがアンケートを送信したイベントを受信する | |
|
メニュー |
メニューが開かれました | WalkMeのメニューが開かれたイベントを受信する |
| メニュー検索 | 検索バーが使用されたイベントを受信する | |
| メニューアイテムが選択されました | ユーザーが検索結果を選択したイベントを受信する | |
|
Shuttle |
Shuttleの目標を達成しました | Shuttleの目標を達成したイベントを受信する |
|
Resource |
Resourceがクリックされました | Resourceが使用されたイベントを受信する |
| Resourceの目標を達成しました | Resourceの目標を達成したイベントを受信する | |
|
TeachMe
|
TeachMeが表示された | TeachMeコースが表示されたイベントを受信する |
| TeachMeステップが開始されました | TeachMeステップが開始された際にイベントを受信する | |
| TeachMeコースが開始されました |
TeachMeコースが開始された際にイベントを受信する | |
| TeachMeコースの完了 | TeachMeコースが完了した際にイベントを受信する | |
| クイズが再生されました | クイズが再生された際にイベントを受信する | |
| クイズが送信されました | クイズが送信された際にイベントを受信する | |
| クイズに合格しました | クイズが送信され、合格した際にイベントを受信する | |
| クイズに失敗しました | クイズが送信され、失敗した際にイベントを受信する | |
|
Digital Experience Analytics（DXA） |
クリック/タップ | サイトのエレメントがクリックまたはタップされた際にイベントを受信する |
| ユーザー入力 | 入力フィールドが操作された際にイベントを受信する | |
| ページビュー | サイトのページが表示された際にイベントを受信する |
技術的なノート
- 注：顧客が提供する証明書の場合、WalkMeは要約された証明書ではなく完全な証明書の使用を求めます。
この記事は役に立ちましたか？
はい
いいえ
ご意見ありがとうございます！