Webhooks are used to share of-the-moment updates, completion and attendance data with a third-party system or LMS, and are typically used in combination with Fuse’s APIs to further enrich that data. A webhook can be thought of as a type of API, driven or triggered by an event in Fuse. Instead of one application making a request to another to receive a response, a webhook is a service that allows one program to send data to another as soon as a particular event takes place.
A list of available REST API endpoints can be found in the Admin panel of each Fuse instance.
How can I use a webhook?
To make use of an available webhook, please raise a ticket in the Fuse Customer Support portal, specifying the URL to which the notifications will be sent.
Available webhooks
The following webhooks are available:
Webhook | Description |
|---|---|
User creation | This webhook notifies your chosen third-party system whenever a new user is created in Fuse. Example: A POST request containing the user_id parameter is sent to the specified third-party URL when a user is created. |
Learning plan completions | This webhook notifies your chosen third-party system whenever a learning plan is created in Fuse. Example: |
User profile updates | This webhook notifies your chosen third-party system whenever a user's profile is updated. Example: A POST request containing the user_id parameter is sent to the specified third-party URL, whenever a user’s profile is updated. |
SCORM completions | This webhook notifies your chosen third-party system whenever a user completes a SCORM course in Fuse. Example: A POST request containing the user_id and content_id parameters is sent to the specified third-party URL, whenever a user completes a SCORM course. |
Event updates | This webhook notifies your chosen third party system whenever an event's status changes. In this case when a user is marked as either Attended or Not attended for an event. A POST request containing the user_id, event_id, and occurrence_id parameters is sent to the specified third-party URL, whenever a user’s attendance status changes for an event. |