Skip to content

xapiActor

Identifies who performed the action.

objectType

  • Flow resource path: statementData > xapiActor > objectType
  • Parameter type: String text
  • Description: Specifies the type of entity the actor is, such as a person or a group. The objectType should be Agent.

Example

"actor": { "objectType": "Agent", "name": "", "mbox": "" }

name

  • Flow resource path: statementData > xapiActor > name
  • Parameter type: String name
  • Description: The display name or identifier for the actor involved in the xAPI statement, as provided by the LRS.

Example

"actor": { "objectType": "", "name": "xAPI Example Statement", "mbox": "" }

mbox

  • Flow resource path: statementData > xapiActor > mbox
  • Parameter type: String mbox
  • Description: An email address used to identify the actor, formatted as a mailto: URI. You must choose either mbox, openid or account to match the data being sent to the flow. A statement can’t contain more than one of these.

Example

"actor": { "objectType": "", "name": "", "mbox": "[email protected]" }

openid

  • Flow resource path: statementData > xapiActor > openid
  • Parameter type: String URI
  • Description: An OpenID identifier for the actor, used for authentication across different systems. You must choose either mbox, openid or account to match the data being sent to the flow. A statement can’t contain more than one of these.

Example

"actor": { "objectType": "", "name": "", "openid": "https://www.example.com/123456" }

account.name

  • Flow resource path: statementData > xapiActor > account > name
  • Parameter type: String name
  • Description: The name associated with the actor's account within a specific system or platform. You must choose either mbox, openid or account to match the data being sent to the flow. A statement can’t contain more than one of these.

Example

"actor": { "objectType": "", "name": "", "account": { "homePage": "", "name": "123456789" } }

account.homepage

  • Flow resource path: statementData > xapiActor > account > homepage
  • Parameter type: String URL
  • Description: The URL of the homepage or profile page of the actor's account on a platform. You must choose either mbox, openid or account to match the data being sent to the flow. A statement can’t contain more than one of these.

Example

"actor": { "objectType": "", "name": "", "account": { "homePage": "https://www.example.com", "name": "" } }