Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Webhooks are used to share of-the-moment completion and attendance data with a client's LMS or other system3rd-party system or LMS, and are often used in combination with Fuse API's (which Fuse’s APIs (A list of APIs can be found in admin panel of your Fuse instancethe Admin panel) 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.

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

...

How can I use Fuse’s webhooks?

You must raise a support ticket in the Fuse Customer Support portal, specifying the URL to which the notifications are to be sent. A member of the Fuse Customer Support team will then add the URL to the applicable webhook.

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.

Panel
bgColor#E3FCEF

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.

Panel
bgColor#E3FCEF

Example:
A POST request containing the user_id and learning_plan_id is sent to the specified third-party URL, each time a user completes a learning plan.

User profile updates

This webhook notifies your chosen third-party system, whenever a user's profile is updated. 

Panel
bgColor#E3FCEF

Example:

A POST request containing the user_id parameter is sent to the specified third-party webhook URL, whenever a user’s profile is updated.

SCORM completions

This webhook notifies your chosen third-party platform, whenever a user completes a SCORM course in Fuse.

Panel
bgColor#E3FCEF

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, and is triggered if a user is marked as Attended or Not attended for an event.

Panel
bgColor#E3FCEF

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.