Event Types

Course Complete JSON

• • Description: When a user completes a course

  • Data: Will take the shape of the JSON below

  • Some Notable Attributes

    • user - The leaner's email address

    • notifiableId - The ID of the course that was completed

    • userDetail > externalCustomerId - The learner's ID, the value associated to their account. This value is utilized during SSO to associate the learner coming from the IDP with their account in the SP (IE product).

    • ref1 - ref3 - Optional data passed from the IDP to the SP (IE product) during SSO can be found in these attributes.

  • When sent via SFTP:

    • File Name Example: courseCompletion-1589259213_2020-05-18T18-00-13-7vcph2i.json

    • Changes: Data will be an array of events sent in batch nightly. In other words, the same events as seen here, but multiple of them grouped into an JSON array.

{

"id": "32ed16df-27cb-5f72-90ff-4eaf39346f86",

"source": "course_completed",

"timestamp": "2019-10-17T20:50:53.103Z",

"type": "status_change",

"user": "bobjohnson@school.com", // learner email

"companyId": "3aabdfb8-3891-5011-ad35-8e2351c5fdaf",

"event": "courseCompletion",

"notifiableId": "7670fdbe-15ed-504b-a680-d404fa4b0eb4", // course id

"title": "New Student Orientation", // course title

"userDetail": { // learner details

"id": "61149b2c-3f37-5032-be63-f5d984de10b6",

"firstName": "Bob",

"lastName": "Johnson",

"externalCustomerId": "111222333444",

"sfContactId": null,

"sfAccountId": null,

"client": "00f928f4-8718-5043-9164-32398b165c60",

"ref1": "111222333444",

"ref2": "Department",

"ref3": "..."

}

}

Course Complete CSV (SFTP only)

• • Description: When a user completes a course

  • File Name Example (SFTP): courseCompletion-1589259213_2020-05-18T18-00-13-7vcph2i.csv

id,source,timestamp,type,user,companyId,event,notifiableId,title,userDetail.id,userDetail.firstName,userDetail.lastName,userDetail.externalCustomerId,userDetail.sfContactId,userDetail.sfAccountId,userDetail.client,userDetail.ref1,userDetail.ref2,userDetail.ref3

32ed16df-27cb-5f72-90ff-4eaf39346f86,course_completed,2019-10-17T20:50:53.103Z,status_change,bobjohnson@school.com,3aabdfb8-3891-5011-ad35-8e2351c5fdaf,courseCompletion,7670fdbe-15ed-504b-a680-d404fa4b0eb4,New Student Orientation,61149b2c-3f37-5032-be63-f5d984de10b6,Bob,Johnson,111222333444,null,null,00f928f4-8718-5043-9164-32398b165c60,111222333444,Department

Legacy Course Certificate JSON (depreciated)

• • Description: When a course certificate should be issued

{

"expirationDate": null,

"id": "1430dddf-1085-529a-af5c-5bbce895cd3d",

"pdfAsset": "https://....",

"progressWasReset": false,

"resource": "d26f53f9-f791-58fc-a9e0-44fdfa245910",

"resourceType": "course",

"url": "/learn/certificates/new-student-orientation",

"user": "bobjohnson@school.com", // learner email

"companyId": "588e42a-f40f-5c5f-894e-0267bf0e5be3",

"timestamp": "2019-07-29T15:08:44.652Z",

"notifiableId": "d26f53f9-f791-58fc-a9e0-44fdfa245910", // course id

"courseTitle": "New Student Orientation",

"courseSku": null,

"courseSlug": "new-student-orientation-1",

"resourceTitle": "New Student Orientation", // course title

"resourceSku": null,

"resourceSlug": "new-student-orientation",

"userDetail": { // learner details

"id": "65cfe566-c740-54b9-8940-e9babb5f8390",

"firstName": "bob",

"lastName": "johnson",

"email": "bobjohnson@school.com",

"externalCustomerId": "111222333444",

"sfContactId": null,

"sfAccountId": null,

"client": "066e61ad-39e6-5f69-bfb0-228dfc4fac5a",

"ref1": "111222333444",

"ref2": "Department",

"ref3": "..."

}

}