Webhook設定

Webhook機能を有効にすることで、イベント発生時にWebhook通知を送信できます。
ここでは、JSON構造や項目についてご案内いたします。

※Webhook通知機能はオプションです。ご希望の場合はサポートまでお問い合わせください。

エンドポイントの設定

エンドポイントを作成の上、以下のページにご登録ください。
WisdomBase管理画面 > CRM連携設定 > Webhook設定

Webhookは登録したエンドポイントに対してPOSTで送信されます。
コンテントタイプはapplication/jsonです。

レクチャー個別設定

Webhook通知を受け取るには各レクチャーで個別にWebhook送信オプションを有効にしてください。

設定手順

1. コース編集画面から対象のレクチャーの「編集」ボタンをクリック
2. レクチャー編集画面の下部にある「外部連携設定」セクションを確認
3. 「レクチャー完了時にWebhookを送信する」チェックボックスをONにする
4. 「保存」ボタンをクリックして設定を保存

注意事項：
・試験レクチャーの場合は、試験設定画面の「結果通知の設定」メニュー内のチェックボックスをONにしてください。
・後採点問題を含む試験レクチャーの場合、試験完了時ではなく採点完了時にWebhookが送信されます
・CRM連携設定画面でWebhook機能が有効になっている場合のみ、この設定項目が表示されます

イベント：レクチャーの完了

試験レクチャーと試験レクチャー以外では、JSON構造と項目が異なります。
また、後採点問題を含む試験レクチャーの場合は、試験完了時ではなく、採点完了時にイベントが発生します。

試験レクチャー

JSON構造

{
  "event": "lecture_completion",
  "courses": {
    "id": 1001,
    "title": "昇進試験2024",
    "type": "ProCourse",
    "instructor": "テスト 講師"
  },
  "lectures": {
    "id": 1001122,
    "title": "テストレクチャー",
    "type": "ExamLecture",
    "position": 1,
    "published": true
  },
  "user": {
    "id": 12345,
    "username": "user1",
    "nickname": "テスト 太郎",
    "email": "sample1@sample.com",
    "role": "Role1",
    "group": ["Group1","Group2"]
  },
  "exam_results": {
    "user_exam_id": 1,
    "total_score": 100,
    "grade": "合格",
    "total_time_spent": "60",
    "submit_type": "正常終了",
    "start_at": "2024-10-24T08:53:52.371Z",
    "finished_at": "2024-10-24T09:53:52.371Z"
  }
}

項目一覧

試験レクチャー以外

JSON構造

{
  "event": "lecture_completion",
  "courses": {
    "id": 1001,
    "title": "昇進試験2024",
    "type": "ProCourse",
    "instructor": "テスト 講師"
  },
  "lectures": {
    "id": 1001122,
    "title": "テストレクチャー",
    "type": "VideoLecture",
    "position": 1,
    "published": true
  },
  "user": {
    "id": 12345,
    "username": "user1",
    "nickname": "テスト 太郎",
    "email": "sample1@sample.com",
    "role": "Role1",
    "group": ["Group1","Group2"]
  },
  "lecture_taking_details": {
    "id": 1,
    "completion_rate": "9/10",
    "lecture_duration": 100,
    "lecture_taking_time": 70,
    "lecture_status": "あり",
    "num_of_completed_lectures": 9,
    "created_at": "2024-10-24T08:53:52.371Z",
    "finished_at": "2024-10-24T09:53:52.371Z",
    "device": "Desktop (Chrome/Mac)"
  }
}

項目一覧