Webhooks allow you to build or set up apps which subscribe to certain events on clui. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to report completion of enrolments, new user signups or purchases to your system. You're only limited by your imagination.
Once installed, the webhook will be triggered each time the subscribed events occurs.
When configuring a webhook, you can choose which events you would like to receive payloads for. Only subscribing to the specific events you plan on handling is useful for limiting the number of HTTP requests to your server. You can change the list of subscribed events through Clui Enterprise Settings anytime.
Each event corresponds to a certain set of actions that can happen to your enterprise. For example, if you subscribe to the “User passes course” event you'll receive detailed payloads every time an enrolment gets passed.
To set up your webhooks, go to Enterprise Settings and choose the Webhooks tab:
On top of the predefined webhooks, you can specify your own events within a course. This can be done by adding an action module to your course with a webhook action. This action gets triggered when a learner reaches this module within the course, and sends the payload to the defined URL.