Webhooks

Last update: Thu Nov 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Webhookを使用すると、特定のイベントが発生したときに、1つのエンティティから別のエンティティにリアルタイムのデータまたは通知を自動的に送信できます。これにより、アプリケーションは常に情報を要求することなく、他のアプリケーションに情報を提供することができます。例えば、ユーザーが学習管理システム(LMS)コースを完了すると、webhookはその情報をCRMやレポートツールなどの別のプラットフォームに自動的に送信できます。 Webhookは、プロセスを自動化し、システム間の手動アップデートの必要性を減らすために、統合でよく使用されます。データの送信先となるコールバックURLを指定して、webhookを設定します。

WebhookとAPIの比較

WebhookとAPIはどちらもシステムが相互に通信するのに役立ちますが、動作の方法は異なります。 APIを使用すると、ユーザーが要求した場合にのみ情報が共有されます。例えば、学習者がコースの進捗状況に関するデータを必要とする場合、学習者はAPIにリクエストを送信し、APIがその情報を提供します。一方、Webhookでは、イベントが発生するとすぐにデータが自動的に送信されます。例えば、学習者がコースを完了すると、手動リクエストなしでデータがリスナーURLにすぐに送信されます。

リアルタイムAPIとは

リアルタイムAPIを使用すると、イベントが発生したときにアプリケーションでデータを即座に交換できます。ユーザーが情報を要求するのを待つ従来のAPIとは異なり、リアルタイムAPIはデータが発生した時点でデータを共有します。 WebhookはリアルタイムAPIとして機能し、指定されたイベントが発生するとすぐにデータを共有できます。リアルタイムAPIにより、手動リクエストを行うことなく、このデータ転送が即座に行われるため、システムが即座に更新されます。

Webhookイベント

Webhookイベントは、リスナーURLにデータを自動的に送信するシステムで発生する特定のアクションです。例えば、学習者がコースに登録すると、webhookイベントがトリガーされ、登録の詳細がリスナーURLに送信されます。
Webhookイベントは、次の2つのカテゴリに分類されます。

リアルタイムイベント:イベントはリアルタイムで処理され、ターゲットURLに送信されます
非リアルタイムイベント:イベントはバッチで処理され、リアルタイムではなく指定された時間に送信されます

リスナーURL

リスナーURLは、イベントが発生したときにデータ情報を受信するエンドポイントまたは宛先です。コースへのユーザー登録など、特定のイベントが発生すると、システムは手動で要求することなく、このURLに詳細を自動的に送信します。リスナーURLは、これらすべてのアップデートが配信されるアドレスです。
Webhookは、関連する情報をJSON形式で送信します。 Adobe Learning Managerでトリガーされるイベントのペイロードの例を次に示します。

{
  "accountId": 1010,
  "events": [
    {
      "eventId": "d5fb7071-10a9-46b2-9f9e-79dde346c052",
      "eventName": "COURSE_ENROLLMENT_BATCH",
      "timestamp": 1727414643000,
      "eventInfo": "1727414643000-047210-84242-0",
      "data": {
        "userId": 4279332,
        "loId": "course:7374992",
        "loInstanceId": "course:7376092_10250977",
        "loType": "course",
        "enrollmentSource": "ADMIN_ENROLL",
        "dateEnrolled": 1727414643
      }
    }
  ]
}

Webhookの作成と管理 – 統合管理者

Adobe Learning ManagerでWebhook統合を作成するには、次の手順を実行します。

統合管理者 としてログインします。
ホームページで、Webhook/Webhookを追加 を選択します。

Webhookを追加
Webhookの名前と説明を入力します。
イベントデータを渡すリスナーURLを ターゲットURL として入力します。
次のいずれかの認証方法を選択します。
Webhooksの認証は、リスナーURLに送信されるデータが信頼できるソースから来ていることを確認するためのセキュリティ方法です。
- なし：認証は不要です。
- 基本：これは資格情報ベースの認証です。ユーザー名とパスワードを入力します。
- 署名:システムは特別な署名を作成し、Webhookデータに追加します。受信側のサーバーはこのコードをチェックして、データが実際のものであり、変更されていないことを確認します。署名を生成し、認証に使用します。署名をJSONとしてダウンロードします。

トリガーイベント ドロップダウンからWebhookイベントを選択します。

note note
NOTE
「 Webhookを追加」ページから「 Webhookをテスト」オプションを選択して、webhookをテストすることもできます。