Webhooks allow you to build or set up apps which subscribe to certain events on Clui. When an event is triggered, Clui sends a HTTP POST payload to the webhook's configured URL.
Webhooks can be used to report activities such as completion of enrolments, new user signups or purchases to your system.
Once installed, the webhook is triggered each time the subscribed events occurs.
Subscribing to events
When configuring a webhook, you can choose the events you want to receive payloads for.
To limit the number of HTTP requests to your server, we recommend only subscribing to the events you plan to handle. You can change the list of subscribed events in your Clui enterprise settings at any time.
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 each time an enrolment is passed.
To set up webhooks, go to Enterprise settings and select the WEBHOOKS tab.
For more information about enterprise settings, see https://support.clui.com/hc/en-us/articles/360021373351-Managing-your-enterprise-settings-administration-.
Using webhooks in courses
In addition to 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. The action is triggered when a learner reaches the module within the course and sends the payload to the defined URL.
For more information about action modules in courses, see https://support.clui.com/hc/en-us/articles/360021337091-Action-modules.