The Litmos Webhooks feature is designed to allow your application to receive notifications when a subscribed event occurs within the LMS. This guide explains the process for configuring webhooks for your organization.

Important Note: Please contact your Account manager for this feature to be enabled for your Litmos account

Configuring Webhooks

Configuring a webhook endpoint can be completed by logging into your Litmos instance. Once logged in, follow these simple steps.

1. From your account profile icon, select Account Settings. From the left-hand menu, click on the Litmos Features menu item.
2. Once you reach the Features screen, click on the Webhooks panel to access the Webhooks configuration screen. (Note: The Litmos Webhooks feature is a premium service. Please contact your Account manager for this feature to be enabled for your Litmos account
3. You have now reached the webhooks configuration screen. This screen will display all webhooks that have been configured including active and inactive. The first thing you will need to do is enable the feature by clicking the “Enable Webhooks” checkbox and clicking on the Save button.

Next, click on the Add Webhook button to add your endpoint. This will route you to the Create Webhook Endpoint screen.

The following steps will need to be completed.

Enter your Endpoint URL

Litmos recommends that you have confirmed that your endpoint meets the below criteria:

• Publicly accessible
• URL needs to be secure (HTTPS)
• Endpoint is configured to handle POST requests
• Endpoint can handle message payloads (JSON)

Choose an Event

Litmos offers 6 hooks for common events:

• Achievement.Earned (course & learning path)
• Session.Created (ILT session created)
• Session.Updated (ILT session updated)
• Session.Registration (ILT session user registration)
• Session.RegistrationUpdate (ILT session user registration)
• ELearningCourse.Processed (SCORM/TinCan course finished processing)
• Learner.Overdue (course overdue)
• Learner.NotCompliant (course compliance expired)

Designate the Active Status

When checked, this tells Litmos that to send messages to your configured endpoint. This is like subscribing and unsubscribing.

Select Authentication Credentials (optional)

A username and password can be used to authorize the webhook event payload at the target endpoint URL. The username and password combo would need to be entered as a "Webhook Credential" for the credential to be used with the webhook event.

The username and password must be verified by the domain entered when adding the new credentials. Also, the endpoint URL entered for the specific webhook event must also recognize and authorize that username and password.

Save

Click the "save" button. Once your webhook has been created it will be displayed on the Webhooks screen.

Your created webhook endpoint has also been assigned a signing secret which allows you to verify the authenticity of messages your endpoint receives. To obtain the signing key for your endpoint, click on the Edit link. This signing key can also be regenerated as needed.

Regenerate Signing Secret

This is the signing key you will use to verify the signature contained in the request header of messages delivered by the Litmos Webhooks service. In cases where your signing secret has been compromised, you can assign your endpoint a new signing key by clicking on the Regenerate Secret button.

Any new messages created by the Litmos webhooks service will use the new signing key to generate the request signature. There may be a period where messages sent by the Litmos Webhook service may be signed using the previous singing secret, therefore we recommend you cater for this scenario when verifying signatures.

Delete Webhooks Endpoint

Deleting the webhooks endpoint will permanently remove the endpoint from Litmos and will result is messages no longer being delivered to this endpoint.