Webhooksとは？

概要

Webhooks（別名コールバック）を使用すると、サードパーティーのAPIをトリガーしたりWalkMeイベントデータを分析プラットフォームに追加したりすることで、ワークフローにWalkMeを直接組み込めます。

APIインテグレーションは、多くの場合リソースを大量に消費し、サードパーティーツールによる制限があるため、一定の間隔を置いて実行されます。 大規模なデータセットを更新する場合はこれで問題ありませんが、即時性が重要なデータに遅延が発生し、場合によっては配信される前にデータが古くなりすぎることもあります。

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

Webhooksはサーバー間の呼び出しを使用して安全にデータを転送し、開発作業の必要はありません。 WalkMeのWebhooksは、GETまたはPOSTメソッドのあらゆるHTTP呼び出しをサポートしています。 ペイロードはJSONである必要があります。

ユースケース

Webhookのユースケースには以下のようなものがあります。

• お使いの分析ツールやBI ツールに リアルタイムのWalkMeイベントを追加できます。
• WalkMeイベントに基づいて サードパーティのAPIをトリガーします。 実装例には以下が挙げられます。
  • ウォークスルーのゴールに到達したら即座にSlack通知を受信
  • エンドユーザーが販促用シャウトアウトをクリックしたらマーケティングリストにユーザーを追加
  • エンドユーザーがWalkMe Survey（調査）を提出して追加のヘルプを要請した場合にZendeskチケットを作成
  • Onboarding（オンボーディング）タスクを完了したユーザーをスプレッドシートに追加することでオンボーディングを追跡します。
  • エンドユーザーがWalkMe NPS調査に回答すると、メールを受信します。

使用方法

Insightsでは、特定のWalkMeイベントを登録したり、 Webhooksを設定したりすることができます。

エンドユーザーがアプリケーション内で登録したWalkMeイベントを操作すると、WalkMeは内部のWalkMeサーバーにイベント通知を送信します。

次に、内部のWalkMeサーバーはWebhooksの設定時に特定した接続先システムに呼び出しを入力します。

Webhooksの構築方法

構築方法については「Webhooksを使ってWalkMeイベントデータをサードパーティーシステムに送信する方法」の記事をご覧ください。

技術的なノート

• Webhooksサービスには5秒のタイムアウト制限があり、長いポーリングリクエスト向けには設計されていません。 通知などの短いリクエストを送信することを目的としています。
• リクエストの処理が5秒の制限を超える場合、顧客はロジックを変更してリクエストを非同期に処理する必要があります。 タイムアウト制限は、顧客ごとに調整できません。