To enable two-way integration with other products and services, Courselle supports updating 3rd-party systems by pushing information about the events you choose via web hooks.
Web hook – is a HTTPS URL pointing to another system that receives notifications from Courselle whenever a certain event happens on your site.
Whenever any of the pre-selected events occur on your Courselle site, for every created web hook, a packet containing the corresponding data is sent to the web hook's URL.
- Course published – triggers whenever a course gets published
- Course unpublished – triggers when a course gets removed from publication (moved to Drafts)
- Course assigned – triggers when a course gets assigned to a user. For bulk assignments, when multiple users get assigned with several courses, each pair user-course triggers a separate web hook event.
- Course started – triggers whenever a user starts a course
Course progress – triggers when a user moves to a new element in the course.
HEADS UP! This event happens very frequently, so the receiving web hook should be ready to handle the load properly
- Course completed – triggers when a user completes a course
- User created – triggers when a new user account gets created. For users invited via email, the trigger fires when the user accepts the invitation. For users manually created in the system either via UI or via API the event triggers at the moment of creation
- User edited – triggers when user properties get updated
- User added to group – triggers when a user gets added to a group
Read full reference, including all examples of web hooks output on API documentation portal.
Configuring web hooks
To create a web hook:
1. Log in to Courselle site
2. Click Settings and go to the API tab,
3. Click Create Web hook.
4. Define the name of the web hook
5. Configure the URL for the web hook
6. Define triggers for sending event data to the web hook
To test your web hook, select any event from the Test URL with event list and click Test URL.
If the test is passed successfully (HTTP code 200), the "Web-hook test passed" message will be displayed.
Otherwise, you will see "Web-hook test failed". In this case, make sure that the provided URL is correct.
Once you are done, click Create.