Webhooks Category

Use the table below to configure the system configuration settings in the Webhooks category.

Setting Type Description
Enrollment webhook URL Text box

Enter the URL for external applications to receive notifications about course enrollments within the LMS. The notifications are delivered via a POST request to the specified URL, with parameters encoded as application/x-www-form-urlencoded.

Enrollment notifications include the following parameters:

  • learnerPermanentId: the permanent (synthetic) ID of the learner who is being enrolled.
  • learnerId: the screen name of the learner who is being enrolled.
  • moduleId: the permanent ID of the module in which the learner is being enrolled.
  • moduleDisplayId: the display ID of the module in which the learner is being enrolled.
  • sessionId: the ID of the module session in which the learner is being enrolled.

The notification is delivered asynchronously. Any delivery failure does not affect the enrollment.
Withdrawal webhook URL Text box Enter the URL for external applications to receive notifications about enrollment withdrawals within the LMS. The notifications are delivered via a POST request to the specified URL, with parameters encoded as application/x-www-form-urlencoded.
Session status change webhook URL Text box Enter the URL for external applications to receive notifications about enrollment status changes within the LMS. The notifications are delivered via a POST request to the specified URL, with parameters encoded as application/x-www-form-urlencoded.
Transcript status change webhook URL Text box Enter the URL for external applications to receive notifications about transcript status changes within the LMS. The notifications are delivered via a POST request to the specified URL, with parameters encoded as application/x-www-form-urlencoded.