TIS Training API Documentation
  • Welcome!
  • Quick Start
  • Managing Users
  • Single Sign On (SSO)
    • General Options
    • Role and Group Mappings
    • Connection Types
      • Microsoft Entra ID (Formerly Azure AD)
      • Google Workspace
      • OpenID Connect (OIDC)
      • SAML (Security Assertion Markup Language)
  • SCORM Packages
  • Webhooks
  • API Reference
    • Users
      • 🔵GET users
      • 🔵GET users/seats
      • 🟢POST users
      • 🟠PUT users
      • 🟢POST users/password
      • 🟡PATCH users/enable
      • 🟡PATCH users/disable
      • 🔴DELETE users
    • Results
      • 🔵GET results
      • 🔵GET results/group
    • Groups
      • 🔵GET groups
      • 🟢POST groups/users
      • 🔴DELETE groups/users
    • 🔵GET courses
    • 🔵GET filters
    • 🟢POST login
    • â›”Standard Error Format
  • Webhook Reference
    • Standard Structure
    • Course Complete
    • Multi-Course Complete
  • OpenAPI Specification
Powered by GitBook
On this page
  • Event Type
  • Data Structure
  1. Webhook Reference

Course Complete

Event sent when a user completes a training course.

This event is sent whenever a user completes a training course, including an individual course completion during a multi-course training module. It will not be sent for the overall completion of a multi-course module. For that event see Multi-Course Complete.

Event Type

COURSE_COMPLETE

Data Structure

Name
Type
Description

resultId

string

The Id of the course result. Formatted as a GUID.

userId

string

The Id of the user that completed the course. Formatted as a GUID.

courseId

string

The Id of the course the user completed. Formatted as a GUID.

score

integer

The score the user obtained for this result.

maxScore

integer

The maximum possible score for this result.

passRate

integer

The pass rate in percent from 0-100, or null if the organisation has not specified a pass rate.

{
  "eventId": "00000000-0000-0000-0000-000000000000",
  "eventType": "COURSE_COMPLETE",
  "organisationId": "00000000-0000-0000-0000-000000000000",
  "sent": "2022-09-20T07:53:12.2664878+00:00",
  "data": {
    "resultId": "00000000-0000-0000-0000-000000000000",
    "userId": "00000000-0000-0000-0000-000000000000",
    "courseId": "00000000-0000-0000-0000-000000000000",
    "score": 5,
    "maxScore": 10,
    "passRate": 80
  }
}
PreviousStandard StructureNextMulti-Course Complete

Last updated 9 months ago