LTI Launch Events ¶

LTI Launch events are posted when a user launches from Brightspace out to an external learning tool via an LTI integration.

The actor is the user who performs the action, and the object is the launch itself. The event object has the following form:

{
        "id": "<EventUUID>",
        "timestamp": "<UTCDateTimeString>",
        "actor": {
                "account": {
                        "homePage": "https://<TenantUUID>.lms.d2l.com/",
                        "name": "urn:uuid:<UserUUID>"
                }
        },
        "verb": {
                "id": "https://api.brightspace.com/xapi/verbs/launched"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<LaunchUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/lti/link/launch"
                }
        },
        "context": {
                "contextActivities": {
                        "category": [
                                {
                                        "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                                }
                        ]
                },
                "registration": "<OrgUnitUUID>",
                "extensions": {
                        "https://api.brightspace.com/xapi/extension_keys/context/actor": {
                                "userId": "<BrightspaceUserIdNumber>",
                                "imsRoleIds": [ <IMSRoles> ],
                                "impersonatingUserId": "<BrightspaceImpersonatingUserIdNumber>",
                                "roleId": "BrightspaceRoleIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/object": {
                                "id": "<BrightspaceIdNumber>",
                                "ltiClientId": "<LtiAdvantageClientId>",
                                "ltiDeploymentId": "<LtiAdvantageDeploymentId>",
                                "ltiToolProviderId": "<LtiLegacyToolProviderId>",
                                "ltiLaunchUrl": "<LtiLaunchURl>",
                                "ltiMessageType": "<LtiMessageType>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "sessionId": "<StableSessionID>",
                                "originalSessionId": "<BrightspaceSessionId>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        }
                }
        }
}

Notes:

<LaunchUUID>: a unique identifier for the LTI launch. This UUID is created by an algorithm whose input is the Brightspace native launch identifier. This UUID will be used whenever this particular launch item is referenced by any BDS event.
<OrgUnitUUID>: a unique identifier for the OrgUnit.
impersonatingUserID: only present if the user is being impersonated by a different user. If this field is present, then the Actor information refers to the person being impersonated, not the impersonator.
ltiClientId, ltiDeploymentId: only present on LTI Advantage launches; indicates the Client and Deployment identifiers Brightspace has for the LTI Tool launched to.
ltiToolProviderId: only present on legacy LTI launches; indicates the LTI Tool Provider identifier Brightspace has for the LTI Tool launcehd to.
ltiLaunchUrl, ltiMessageType: launch URL launched to, and the LTI-specified message type string for the user’s launch.
sessionId, originalSessionId: persistent unique identifier to the session governing the LTI launch (created by an aglorithm whose input is the Brightspace native session identifier and tenant identifier); also, the Brightspace native session identifier.
originalEventId: only provided for use by D2L personnel if needed for troubleshooting.

See Fundamental xAPI Concepts for information on other fields.

Brightspace Data Streams (July 2023)

LTI Launch Events

LTI Launch Events¶

LTI Launch Events ¶