Content Service Events ¶

Content Service events are posted when a user performs any action pertaining to managing activities within the Brightspace Content Service.

For example, a content service event occurs when an instructor adds a new activity to the content service.

The actor is the user who performs the action, and the object is the activity in the content service involved. 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/<ActivityVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<ActivityUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/content_service/activity"
                }
        },
        "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>",
                                "parentObjectId": "ParentObjectIdNumber",
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        }
                }
        }
}

Notes:

<ActivityVerbString>

may be one of

created
updated
deleted

<ActivityUUID>

a unique identifier for the content item. This UUID is created by an algorithm whose input is the TenantID and content service activity item information. This UUID will be used whenever this 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.

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)

Content Service Events

Content Service Events¶

Content Service Events ¶