Who is this article for?

System administrators and developers who need to integrate Damstra Learning with third-party applications using real-time data.

Admin access and Integration Management permissions are required.

This article explains how WebHook integration works in Damstra Learning, including supported events, message formats, and how to add or remove WebHooks.

📌 What it is

WebHook integration allows Damstra Learning to send real-time data to external systems using HTTP POST requests. This method is more efficient than traditional APIs, which rely on polling.

Messages are sent in JSON format to specified Uniform Resource Identifiers (URIs) after certain events occur.

🚀 Why it matters

WebHooks enable instant communication between Damstra Learning and third-party platforms, improving automation, responsiveness, and data accuracy across systems.

🔑 Key points

• WebHooks use HTTP POST to send real-time data.
• Multiple URIs can be configured for different events.
• Messages are triggered by specific platform actions.
• JSON format ensures compatibility with most systems.

📋 WebHook events supported

• Lesson Schedule Completed – Triggered when a trainee completes a scheduled lesson.
• Lesson Schedule Changed – Triggered when an admin modifies a lesson schedule; one message per affected trainee.
• Lesson Schedule Created – Triggered when a lesson is scheduled; one message per scheduled trainee.
• Lesson Schedule Canceled – Triggered when a scheduled lesson is canceled; one message per affected trainee.
• User Created – Triggered when a new user account is created.
• User Updated – Triggered when user details are updated.
• User Inactivated – Triggered when a user account is deactivated.
• All Events – Sends a message for any of the above events.

🔍 Event details

For full payload specifications and examples, visit the Damstra Learning developer site.Integrations tab under Admin.

• Select WebHooks (availability may vary by subscription level).
  
• Enter your target URI in the WebHook URI field.
  
• Choose the event you want to monitor (or select All Events).
• Click Add to save the WebHook.
• Repeat to add multiple WebHooks if needed.
  
  

🗑️ Removing a WebHook

1. Locate your existing WebHook in the list below the Add section.
2. Click the Trash Can icon next to the WebHook.
3. The WebHook will be deleted, and future posts to that URI will stop.