MeasureOne Link Events

Events are triggered based on user activity in the widget. These events provide information to you to enhance the experience within your application. The following table provides the details of supported Action Events. Each Action Event may have additional data that provides additional context for the event. The following sections describe various events generated by the MeasureOne Link widget

`individualCreated`(Deprecated)

Triggered when the Individual is created by MeasureOne Link. This event is deprecated. You must create an Individual before bringing up the Link experience

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data for the event
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne

Example:

{
  "name": "individualCreated",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp"
  }
}

`individualUpdated`

Triggered when the Individual is updated by MeasureOne Link.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data for the event
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne

Example:

{
  "name": "individualUpdated",
  "data": { "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp" }
}

`consentStatusChanged`

Triggered when the Individual accepts the Consumer Privacy Policy and agrees to give Consent to MeasureOne.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne
├ `accepted`	boolean	Whether individual has given consent to MeasureOne
├ `datarequest_id`	string	Unique ID of the Data Request

Example:

{
  "name": "consentStatusChanged",
  "data": { 
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "accepted": true
  }
}

`currentProgress` (Deprecated)

Triggered when the screen changes. Returns the value in percentage. If the screen is error, the value of the progress will be -1. The attributes in the data object of this event will vary depending on the screen transition

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `progress`	string	Progress value in percentage
├ `datarequest_id`	string	Unique ID of the Data Request
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne

Example:

{
  "name": "currentProgress",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "progress": 50
  }
}

`datasourceConnected`

Triggered when the User submits the credentials successfully on the Widget. In case of MFA, this event will be triggered after the MFA is submitted successfully

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `session_id`	string	Session ID of the MeasureOne Link for this connection.
├ `connection_id`	string	Unique ID of connection identified by MeasureOne.
├ `data_source_id`	string	Unique ID of the data source identified by MeasureOne.
├ `data_source_name`	string	Display name of the data source.
├ `checkcodes_created`	string	Whether checkcodes are created for this connection.
├ `datarequest_id`	string	Unique ID of the Data Request identified by MeasureOne.
└ `individual_id`	string	Unique ID of the Individual identified by MeasureOne.

Example:

{
  "name": "datasourceConnected",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "data_source_id": "sch_CV8e5NzZXwXhNp3TGnpryEmub2E",
    "data_source_name": "New Jersey Institute Of Technology",
    "session_id": "tls_1t1beGRERflQjl3ctpNJdzQB7D1",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "checkcodes_created": "true/false"
  }
}

`itemsCreated`

Triggered when one or more items are manually uploaded by the Individual

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne.
├ `datarequest_id`	string	Unique ID of the Data Request identified by MeasureOne.
├ `items`	array	List of Items uploaded manually.
│ ├ `id`	string	Unique ID of the item uploaded manually.
│ └ `source_data_type`	string	The type of the source data.
└ `data_source_id`	string	Unique ID of the data source identified while uploading the item.

Example:

{
  "name": "itemsCreated",
  "data": {
    "individual_id": "idv_1yrARBpkCSP4zOiFFrG2L3nWKgo",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "items": [
      {
        "id": "itm_21uqbxrF4BEQwXo4hJFnox2G11j"
      }
    ],
    "data_source_id": "sch_CV8e5NzZXwXhNp3TGnpryEmub2E"
  }
}

`tokenExpired`

Triggered when the access_key expires at any stage in the widget.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `datarequest_id`	string	Unique ID of the Data Request
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne
`error_description`	string	Description of the error occurred in Link

Example:

{
  "name": "tokenExpired",
  "data": { 
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp", 
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp" 
  },
  "error_description": "Your session has expired, please refresh the page."
}

`credentialsNotObtained`

Triggered when the user chooses to exit MeasureOne Link after attempting to reset their password.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne.
├ `datarequest_id`	string	Unique ID of the Data Request identified by MeasureOne.
├ `data_source_id`	string	Unique ID of the data source identified by MeasureOne.
└ `data_source_name`	string	Display name of the data source.

Example:

{
  "name": "credentialsNotObtained",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "data_source_id": "sch_CV8e5NzZXwXhNp3TGnpryEmub2E",
    "data_source_name": "New Jersey Institute Of Technology"
  }
}

`datasourceNotSupported`

Triggered when the selected data source by user is not supported by MeasureOne

Reason Codes

Reason Code	Description
`USER_LOGIN_NOT_SUPPORTED`	User login is not supported for the data source selected by the Individual.
`NO_MATCH_FOUND`	Could not find matching data sources for the information provided.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne.
├ `datarequest_id`	string	Unique ID of the Data Request identified by MeasureOne.
├ `reason_code`	string	Reason code for this event. Possible values: `USER_LOGIN_NOT_SUPPORTED`, `NO_MATCH_FOUND`.
└ `user_inputs`	object	Inputs provided by the Individual for this event.
└ `system_name`	string	System name provided by the Individual which is not supported.

Example:

{
  "name": "datasourceNotSupported",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "reason_code": "NO_MATCH_FOUND",
    "user_inputs": {
      "system_name": "New Jersey Institute of Technology"
    }
  }
}

`exitRequested`

Triggered when the user chooses to exit the MeasureOne Link experience.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data
├ `individual_id`	string	Unique ID of the Individual identified by MeasureOne
├ `datarequest_id`	string	Unique ID of the Data Request

Example:

{
  "name": "exitRequested",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp"
  }
}

MeasureOne Link Events

individualCreated(Deprecated)

Example:

individualUpdated

Example:

consentStatusChanged

Example:

currentProgress (Deprecated)

Example:

datasourceConnected

Example:

itemsCreated

Example:

tokenExpired

Example:

credentialsNotObtained

Example:

datasourceNotSupported

Reason Codes

Example:

exitRequested

Example:

Was this helpful?

`individualCreated`(Deprecated)

`individualUpdated`

`consentStatusChanged`

`currentProgress` (Deprecated)

`datasourceConnected`

`itemsCreated`

`tokenExpired`

`credentialsNotObtained`

`datasourceNotSupported`

`exitRequested`