Using webhooks in Clui

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.

Note: For information about using Clui's API, see 'Accessing developer API documentation'.

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 learning space settings at any time.

Each event corresponds to a certain set of actions that can happen to your learning space. For example, if you subscribe to the “User passes course” event, you'll receive detailed payloads each time an enrolment is passed.

For information about ensuring data security when using webhooks, see 'Ensuring security when using webhooks'.

Setting up webhooks in your learning space

To set up webhooks in Clui, follow these steps:

1. Click the arrow next to your account name in the top-right corner of Clui and select Learning space settings.
2. Change to the WEBHOOKS tab.
3. Click Create a webhook or Create (if this is not your learning space's first webhook).
4. Give the webhook a name and provide a Post URL (which is the website address where the webhook data is sent to).
5. Select the webhooks you want to apply (hover over the Help icon next to a webhook type for a sample JSON payload).
6. Click Test.
7. Verify that the webhook data was received by the POST URL. 
8. Click Save.

The webhook appears in the table of webhooks for your learning space. Hover over the webhook and click the menu icon that appears to access the Edit, Disable or Enable, and Delete actions.

For more information about learning space settings, see 'Managing your learning settings'. 

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 'Using action modules to automate a course'.