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

Download as PDF

概要

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

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

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

Webhookの詳細については、「Webhookとは？」の記事をご覧ください。

ユースケース

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

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

1. 1. Insightsアカウントにサインインします。
      
   2. 左側のサイドバーで［Integrations（統合）］をクリックします
      。
   3. Webhookをクリックします。
      
   4. ［+ NEW WEBHOOk（＋新しいWEBHOOk）］をクリックします。
      
      
      • これによりWebhook作成ウィザードが開始されます。
   5. 後で識別できるようにWebhookに名前を付けます。
      
      
   6. ［CONTINUE（続行）］をクリックします。
   7. Webhookウィザードの最初のステップ（イベントを選択）を完了します。
      1. イベントのドロップダウンメニューから［WalkMe Event（WalkMeイベント）］を選択します。
         

         利用可能なイベントオプションの全リストを確認するには、この記事の下部にある表をご覧ください。

      2. WalkMeイベントを選択した後、ステートメントの条件を選択し、必要に応じて入力します。
         
      3. Webhook呼び出しで受けたいイベントのプロパティを指定する場合は、［Advanced（高度なセクション）］ドロップダウンの三角形をクリックします（任意）。
         
         • 必要に応じて、接続先のシステムの期待される属性と一致するようにプロパティの名前を変更できます。 名前を変更しない場合、これらはWebhookコールで受け取ることになる値です。
           • プロパティ名にスペースは使用できません。
           • 「_」またはcamelCaseを使用して単語を区切ることをお勧めします。
         • また、Webhookコールと一緒に送信する追加の静的プロパティを設定することもできます。
           • ［+ ADD PROPERTY（＋プロパティの追加）］ボタンをクリックします。
           • キーや値にスペースは使用できません。
           • 「_」またはcamelCaseを使用して単語を区切ることをお勧めします。
   8. Webhookウィザードの2番目のステップ（接続先を選択）を完了します。
      1. イベントデータの送信先となるサードパーティのプラットフォーム（接続先システム）の名前を入力します（例：Heap Analytics、Mixpanel、Google Analyticsなど）。
         
      2. リクエストタイプと接続先のURLを設定します。
         
         • これらはWebhookコールをどのように、そしてどこに行うかを指定します。
         • これらの詳細については、接続先システムのAPIドキュメントをご覧ください。
      3. 認証タイプを選択して値を入力します（任意）。
         • 接続先システムのAPIドキュメントを参照して、必要かどうかを確認します。
         • WalkMeは以下の認証方法に対応しています。
           • 認証なし
           • Bearerトークン- トークンが必要
           • 基本認証 – ユーザー名とパスワードが必要
           • OAuth 2.0
      4. Webhookコールの実行に必要なヘッダーの値を入力します（任意）。
         • 接続先システムのAPIドキュメントを参照して、必要かどうかを確認します。
      5. 情報を確認して、［SAVE（保存）］ボタンをクリックします。
      6. これで、エディターでブランク公開が必要であるというポップアップが表示されるようになりました。 実行してください。
         

ヒント：InsightsのWebhook統合セクションの接続先設定画面で接続先を管理できます。

1. 1. Webhookを公開します（最初のWebhookの場合のみ）。
      1. WalkMe Editorアカウントにサインインします。
      2. 青い管理バーの［Menu（メニュー）］をクリックします。
         
      3. Webhookを公開する環境を選択します。
      4. すべてのアイテムのチェックを外して、［Publish（公開）］ボタンをクリックします。
         • WalkMeアイテムが公開されていないため、これは「ブランク公開」と呼ばれます。
   2. Webhookの設定が以下のように正常に行われていることを確認します。
      1. アプリケーションを入力します。
      2. Webhookが追跡しているイベントを実行します。
      3. 設定した接続先のシステムがWebhookコールを受信し、目的の結果を実行していることを確認します。

利用可能なイベント一覧

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