Webhooks are used to share of-the-moment updates, completion and attendance data with a client's LMS or other systemthird-party system or LMS, and are often typically used in combination with Fuse API's (which can be found in admin panel of your Fuse instance) Fuse’s APIs to further enrich that of-the-moment data. A webhook can be thought of as a type of API that is , 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.
| Info |
|---|
Fuse comes with several webhooks that can be used when the following things occur:
A new user is created
An existing user's profile is updated
A new learning plan is created
A user completes a SCORM course
An event's status changes
How can I use Fuse webhooks?
By providing a URL in which they are to be sent and creating a support ticket for us to add that URL and turn on the webhook.
Example webhooks
Learning plan completion
A POST request containing the learning_plan_id and user_id parameters is sent to the third-party webhook URL, specified by the client.
user_id=XXXX
learning_plan_id=XXXX
...
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.
| |||||
Learning plan completions | This webhook notifies your chosen third-party system whenever a learning plan is created in Fuse.
| |||||
User profile updates | This webhook notifies your chosen third-party system 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.
|
...
|
...
|
...
|
...
| ||||||
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.
|
...
|
...
|
...
|
...
|
...
|
...
|