xAPI Configuration

How to get started with Security Journey's xAPI

Roman Oliver avatar
Written by Roman Oliver
Updated over a week ago

Security Journey does provide xAPI access if you were interested in pushing learners completion data from the Platform directly into your LMS of choice. This feature is not enabled by default and can be turned on by request by reaching out to your Customer Success Manager or emailing support@securityjourney.com.

What data do we provide?

Events that will be passed to the LMS (Learning Management System) per the xAPI standard:

  1. Level Completed

  2. Lesson Passed

  3. Lesson Failed

Note: this is a one way communication to your LMS.


Getting Started

Once the feature is enabled you can find it by going to Admin > Settings > LRS.


โ€‹

From here, you will need to click the red lock in the upper right corner to make changes to the settings. You will need:

  • LRS URL

  • Username

  • Password

You will also choose your authentication type. We support:

  • oauth

  • basic

In the example below, we were using SCORM Cloud:

undefined-Feb-15-2022-04-14-10-00-PM

undefined-Feb-15-2022-04-14-34-42-PM

xAPI JSON Examples

This example contains:

  • Learner's email address (mbox)

  • Path(s) completed

  • First & Last Name

  • Completion date

{
"id": "dc3e5a9e-f3f1-42f7-bdba-17b183cf48f1",
"actor": {
"objectType": "Agent",
"name": "Peter Fisher",
"mbox": "mailto:peter_fisher@securityjourney.com"

},

"verb": {
"id": "https://w3id.org/xapi/dod-isd/verbs/completed",
"display": {
"en-US": "completed"
}
},
"timestamp": "2022-04-25T21:01:37.128Z",
"stored": "2022-04-25T21:01:37.128Z",
"authority": {

"objectType": "Agent",
"account": {
"name": "2kd0p5QmszkWsLrsaRc",
"homePage": "http://cloud.scorm.com"
}
},
"version": "1.0.0",
"object": {
"id": "https://business.securityjourney.com/belts/1",
"definition": {
"name": {
"en-US": "White Belt"
}
},
"objectType": "Activity"
}

}

Customers who are still on our legacy Security Journey site (URL domain.securityjourney.com NOT my.securityjourney.com) can also leverage SAML/SSO to pass a unique identifier (employee number or employeeId) instead of emailAddress as the primary identifier. If you are interested in this feature please reach out to Customer Support.

This example contains:

  • Learner's employee_number passed via SAML login (ex: 000998455) instead of First & Last name

  • Learner's email address (mbox)

  • Path(s) completed

  • Completion date

{
"id": "8f269466-f43f-4229-a4e4-d532dc7277a6",
"actor": {
"name": "000998455",
"objectType": "Agent",
"mbox": "mailto:peter_fisher@securityjourney.com"
},
"verb": {
"id": "https://w3id.org/xapi/dod-isd/verbs/completed",
"display": {
"en-US": "completed"
}

},
"timestamp": "2022-04-25T20:56:46.583Z",
"stored": "2022-04-25T20:56:46.583Z",
"authority": {
"objectType": "Agent",
"account": {
"name": "2kd0p5QmszkWsLrsaRc",
"homePage": "http://cloud.scorm.com"
}
},
"version": "1.0.0",
"object": {
"id": "https://business.securityjourney.com/belts/1",
"definition": {
"name": {
"en-US": "White Belt"
}
},

"objectType": "Activity"
}
}

This example contains:

  • First & Last name

  • Learner's email address (mbox)

  • Completion date

  • Module Passed/Failed ("Introduction to Security Journey!")

 
{
"id": "b8dc6d26-37f2-45d6-acaf-7d45b372e86e",
"actor": {
"objectType": "Agent",
"name": "Peter Smith",
"mbox": mailto:peter_smith@securityjourney.com
},
"verb": {
"id": https://w3id.org/xapi/dod-isd/verbs/passed,
"display": {
"en-US": "passed"
}
},
"timestamp": "2023-05-03T20:04:19.894Z",
"stored": "2023-05-03T20:04:19.894Z",
"authority": {
"objectType": "Agent",
"account": {
"name": "zxevq7yCSyQz8u9LqeY",
"homePage": http://cloud.scorm.com
}
},
"version": "1.0.0",
"object": {
"id": https://my.securityjourney.dev//belts/1/modules/411/lesson,
"definition": {
"name": {
"en-US": "Introduction to Security Journey!"
}
},
"objectType": "Activity"
}
}
Did this answer your question?