MeasureOne Link Events
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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
├ `datarequest_id`	string	Unique ID of the Data Request

Example:

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

`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 identified by MeasureOne

Example:

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

`currentProgress`

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 identified by MeasureOne

Example:

{
  "name": "currentProgress",
  "data": {
    "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.
├ `datasource_id`	string	Unique ID of the data source identified by MeasureOne.
├ `datasource_name`	string	Display name of the data source.
├ `datarequest_id`	string	Unique ID of the Data Request identified by MeasureOne.
└ `individual_id`	string	Unique ID of the Individual identified by MeasureOne.

Example:

{
    "data": {
        "individual_id": "idv_2s1Bx4XSDX7aDZpTuyXPMy91c71",
        "connection_id": "cn_2ytTJqkKXUJ9xpVpri1zqkvsHZK",
        "datarequest_id": "dr_30Djm0G4OEramn9sjp9a0WxGOyQ",
        "session_id": "tls_30DjuOLiNF1Z9iX7y91g56lue6m",
        "datasource_id": "brk_1valb8EsXaGQdStmrMCvgi2JZaV",
        "datasource_name": "MeasureOne Brokerage"
    },
    "name": "datasourceConnected"
}

`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.
├ `datasource_id`	string	Unique ID of the data source identified while uploading the item.
├ `datasource_name`	string	Display name of the data source.
└ `items`	array	List of Items uploaded manually.
├ `id`	string	Unique ID of the item uploaded manually.
└`sourcedata_type`	string	The type of the source data.

Example:

{
    "data": {
        "individual_id": "idv_2s1Bx4XSDX7aDZpTuyXPMy91c71",
        "items": [
            {
                "id": "itm_30DjY6654kQvN70ctDsFUsCtgwk",
                "source_data_type": "PAYSTUB_FILE"
            },
            {
                "id": "itm_30DjYG0vlan94LEqliGtAs4z8vA",
                "source_data_type": "PAYSTUB_FILE"
            }
        ],
        "datasource_id": "emp_28SvJwpPMt1qPuSQy6dEwdzuvKg",
        "datarequest_id": "dr_2x7W5oqNfRaAlX0U95DiUbdT9ua",
        "datasource_name": "Oracle HCM"
    },
    "name": "itemsCreated"
}

`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 identified by MeasureOne
├ `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.
├ `datasource_id`	string	Unique ID of the data source identified by MeasureOne.
└ `datasource_name`	string	Display name of the data source.

Example:

{
  "name": "credentialsNotObtained",
  "data": {
    "individual_id": "idv_1gNIu83UT3IwCYcQ6SbtKJAuUWp",
    "datarequest_id": "dr_1gNIu83UT3IwCYcQ6SbtKJ3243Wp",
    "datasource_id": "sch_CV8e5NzZXwXhNp3TGnpryEmub2E",
    "datasource_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.
├ `error_description`	string	Description of the error occurred in Link
├ `reason_code`	string	Reason code for this event. Possible values: `USER_LOGIN_NOT_SUPPORTED`, `NO_MATCH_FOUND`.
├ `datasource_name`	string	Display name of the data source.
└ `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:

{
    "data": {
        "individual_id": "idv_30Dk9eiizPQfPdr2G66GU40bdKY",
        "error_description": "We are unable to complete the transaction at this time.",
        "datarequest_id": "dr_30Dk9kjFLVOwdgYeP8zhG2oa6Q7",
        "reason_code": "USER_LOGIN_NOT_SUPPORTED",
        "user_inputs": {
            "system_name": "Christ Hospital New Jersey"
        },
        "datasource_name": "Christ Hospital New Jersey"
    },
    "name": "datasourceNotSupported"
}

`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 identified by MeasureOne

Example:

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

`widgetInitiated`

Triggered when the widget is successfully initiated.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data for the event
├ `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": "widgetInitiated",
  "data": {
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj"
  }
}

`datasourceClassified`

Triggered when a datasource is classified and ready for the User to submit credentials.

Property	Type	Description
`name`	string	Name of the event
`data`	object	Additional data for the event
├ `individual_id`	string	Unique ID of the Individual
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource

Example:

{
  "name": "datasourceClassified",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1t24BjBBG13ksof6SdbYxmUAKNI",
    "datasource_name": "ADP Payroll"
  }
}

`loginAttempted`

Triggered when the User submits credentials on the widget.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource
├ `connection_id`	string	Unique ID of the connection identified by MeasureOne
├ `session_id`	string	Session ID of the MeasureOne Link for this connection

Example:

{
  "name": "loginAttempted",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "session_id": "tls_32dslkjchfsdkljckjd"
  }
}

`additionalCredentialsRequired`

Triggered when additional credentials (e.g., MFA) are required from the User after submitting initial credentials.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource
├ `connection_id`	string	Unique ID of the connection identified by MeasureOne
├ `session_id`	string	Session ID of the MeasureOne Link for this connection

Example:

{
  "name": "additionalCredentialsRequired",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "session_id": "tls_32dslkjchfsdkljckjd"
  }
}

`invalidCredentials`

Triggered when the User submits invalid credentials.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource
├ `connection_id`	string	Unique ID of the connection identified by MeasureOne
├ `session_id`	string	Session ID of the MeasureOne Link for this connection

Example:

{
  "name": "invalidCredentials",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "session_id": "tls_32dslkjchfsdkljckjd"
  }
}

`datasourceUnavailable`

Triggered when a classified datasource is unavailable for connection.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource
├ `connection_id`	string	Unique ID of the connection identified by MeasureOne
├ `session_id`	string	Session ID of the MeasureOne Link for this connection

Example:

{
  "name": "datasourceUnavailable",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "session_id": "tls_32dslkjchfsdkljckjd"
  }
}

`forgetUsernamePassword`

Triggered when the User clicks "Forgot Password" on the credentials screen.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource

Example:

{
  "name": "forgetUsernamePassword",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll"
  }
}

`additionalCredentialsProvided`

Triggered when the User submits the additional credentials (MFA) on the widget.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource
├ `connection_id`	string	Unique ID of the connection identified by MeasureOne
├ `session_id`	string	Session ID of the MeasureOne Link for this connection

Example:

{
  "name": "additionalCredentialsProvided",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "session_id": "tls_32dslkjchfsdkljckjd"
  }
}

`additionalCredentialsInvalid`

Triggered when the User submits additional credentials (e.g., MFA) on the widget.

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
├ `datarequest_id`	string	Unique ID of the data request identified by MeasureOne
├ `datasource_id`	string	Unique ID of the datasource identified by MeasureOne
├ `datasource_name`	string	Display name of the datasource
├ `connection_id`	string	Unique ID of the connection identified by MeasureOne
├ `session_id`	string	Session ID of the MeasureOne Link for this connection

Example:

{
  "name": "additionalCredentialsInvalid",
  "data": {
    "individual_id": "idv_2y4pdGqzbeFpQGNadi90olFGEgj",
    "datarequest_id": "dr_2yH2sqp4l9ECP26gkH6NQL7CIcu",
    "datasource_id": "emp_1tnet5VGjeBJKiRuow5cQPjWnYs",
    "datasource_name": "ADP Payroll",
    "connection_id": "cn_1t1beHJKk5fbq2moTWj9oFv2hHH",
    "session_id": "tls_32dslkjchfsdkljckjd"
  }
}

MeasureOne Link EventsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

individualCreated(Deprecated)

Example:

individualUpdated

Example:

consentStatusChanged

Example:

currentProgress

Example:

datasourceConnected

Example:

itemsCreated

Example:

tokenExpired

Example:

credentialsNotObtained

Example:

datasourceNotSupported

Reason Codes

Example:

exitRequested

Example:

widgetInitiated

Example:

datasourceClassified

Example:

loginAttempted

Example:

additionalCredentialsRequired

Example:

invalidCredentials

Example:

datasourceUnavailable

Example:

forgetUsernamePassword

Example:

additionalCredentialsProvided

Example:

additionalCredentialsInvalid

Example:

Was this helpful?

MeasureOne Link Events
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

`individualCreated`(Deprecated)

`individualUpdated`

`consentStatusChanged`

`currentProgress`

`datasourceConnected`

`itemsCreated`

`tokenExpired`

`credentialsNotObtained`

`datasourceNotSupported`

`exitRequested`

`widgetInitiated`

`datasourceClassified`

`loginAttempted`

`additionalCredentialsRequired`

`invalidCredentials`

`datasourceUnavailable`

`forgetUsernamePassword`

`additionalCredentialsProvided`

`additionalCredentialsInvalid`