Reporting course completion

Requesting integration

To enable the reception of completion status updates when a learner finishes a course, kindly furnish Masterplan Customer Support with the url leading to the API endpoint on your system. This endpoint will serve as the designated target for completion status payloads.

Additionally, please indicate the preferred authorization method for sending completion status:

• Basic Authentication: Provide Masterplan Customer Support with the requisite username and password.
• OAuth2 Authentication: Supply Masterplan Customer Support with the client id, client secret, and token url.

Request payload structure

The default structure of the request payload is provided below. However, customization of the payload structure is available upon request. If necessary, please provide an example of the required structure along with the webhook target URL. Additionally, custom constant headers can be set to accompany the request (e.g. for facilitating routing on the client side).

{
  "user_id": "47394dd0-2106-4b9a-001a-bb1ebb89eb74",
  "course_id": "a269678b-aa77-4410-9191-d117071fdd02",
  "completed_at": 1680158111,
  "metadata": {
    "email": "johndoe@example.com"
  }
}

Default request schema:

Default metadata schema: