Webhooks Category

System administrators can use the table below to help them configure the system configuration settings in the Webhooks category.

To configure Webhooks settings, go to Manage Center > System > System Configuration and select Webhooks from the Select a category drop-down list.

Table: System Configuration Settings: 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.

Additional Information