Webhookを使用して、WalkMeイベントデータをサードパーティーシステムに送信する方法

概要

Webhook（別名コールバック）を作成したり、カスタマイズしたりして、特定の結果をトリガーするために使用するサードパーティシステムにWalkMeのイベントデータを送信することにより、リアルタイムでデータに基づいた意思決定を行ったり、その場で体験したりすることができます。

イベント自体がトリガーするWebhookなら、任意のシステムにリアルタイムのWalkMeイベント情報を配信できます。 つまり、 遅延なく情報を受け取ることにより、チームは即時性が重要な情報に対して即座に対応できるようになります。

Webhookは分析／BIツールにWalkMeイベントデータを追加したり、サードパーティのAPIをトリガーしたりすることに使用できます。 これでユーザーがShoutOutをクリックすると、メールマーケティングシステムのメールリストに追加したり、NPSアンケートに回答した際にSlackチャネルに即座に通知を送信したりすることができます。 Webhookを使用すると、研究開発の手間をかけずにワークフローにWalkMeを直接構築できます。

webhooksの詳細については、以下の記事を参照してください：Webhooksとは何ですか？

ユースケース

• WalkMeイベントデータを分析BI ツールに統合する
• ユーザーがWalkMeを利用した際に、メールリストにユーザーを追加する
• ユーザーがアクションを実行した後に、即座に通知をSlackチャネルに直接送信する

Webhookを使用してWalkMeデータを送信する手順

1. 1. インサイトの統合ページ（insights.walkme.com）に移動します
      
   2. リアルタイム統合の下にあるWebhooksをクリックします。
      
   3. + NEW WEBHOOKをクリックします
      
   4. Webhookに名前を付け、続行をクリックします。
   5. webhookイベントの詳細を入力します
      1. イベントドロップダウンからWalkMeイベントを選択します。
      2. オプション条件を追加します
         • SWTステップに基づいてwebhookを送信する場合、顧客サーバーに以下の2つのイベントを送信する必要があります：
           1. ステップが環境に表示される場合
           2. ステップが完了したとき（閉じられた、進行中、失敗した場合など）
         • これを行うには、画像に示すように、ステップステータスルールをウェブフック条件に追加します。
      3. Advanced>のドロップダウンセクションでは、選択したイベントのどのプロパティを設定するかを指定できます。
         • 宛先システムが期待する属性に合わせてプロパティの名前を変更できます。
         • 名前を変更しない場合、これらはWebhookコールで受け取ることになる値です。
         • + ADD PROPERTYボタンを使用して、Webhook呼び出しと一緒に送信する追加の静的プロパティを設定することもできます。
           • プロパティ名にスペースは使用できません。
           • 「_」またはcamelCaseを使用して単語を区切ることをお勧めします。
   6. ［Continue（続行）］をクリックします。
   7. webhookの宛先詳細を入力します
      1. 宛先プラットフォーム名を入力します。
         • これは、イベントデータを送信したいサードパーティプラットフォームです。例：Heap Analytics、Mixpanel、Google Analyticsなど
      2. リクエストタイプと宛先URLを入力します
         • これらは、Webhookコールの実行方法と場所を指定します。
         • これらの詳細については、接続先システムのAPIドキュメントをご覧ください。
      3. オプションの認証タイプを選択します。
         • 宛先システムのAPIドキュメントを参照して、これが必要かどうかを確認します
         • WalkMeは以下の認証方法に対応しています。
           • 認証なし
           • ベアラートークン：トークンが必要です
           • Basic Auth：ユーザー名とパスワードが必要です
           • OAuth 2.0
      4. + ADD PROPERTYボタンを使用して、任意のヘッダーを入力します。
         • これらは、webhookコールを実行するために必要な値です。
         • 宛先システムのAPIドキュメントを参照して、これが必要かどうかを確認します
   8. ［Save（保存）］をクリックします。
   9. エディタで設定の公開を実行するように求められます。
      • このステップは、最初に作成するWebhookにのみ必要です
      • 詳細については、以下の記事を参照してください：グローバル設定を公開する方法

Webhookを正常に設定したことを確認するには、以下の手順に従います：

1. アプリケーションを入力します
2. webhookが追跡しているイベントを実行します
3. 設定した宛先システムがwebhookコールを受信し、目的の結果を実行していることを確認します。

利用可能なイベント一覧

以下の表には、Webhookイベントを作成する際に利用可能なすべてのオプションが表示されています。

技術的なノート

• 注：顧客が提供する証明書の場合、WalkMeは要約された証明書ではなく完全な証明書の使用を求めます。