onEvent types

Event TypeEvent PayloadDescription
LOADNoneWhen BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Truv and allow you to access their accounts via the Truv. module has finished loading
OPENOpenDataWhen BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Truv and allow you to access their accounts via the Truv. is open and ready to use
SCREEN_VIEWScreenViewDataWhen a screen of the BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Truv and allow you to access their accounts via the Truv. was viewed
EMPLOYER_SELECTEDEmployerSelectedDataWhen employer was selected in the Bridge
LINK_CREATEDTaskDataWhen a user attempts to log in to their payroll provider
LOGIN_COMPLETEDTaskDataWhen a user successfully logs in to their payroll provider
SUCCESSTaskDataWhen a user's data successfully retrieved from their payroll provider
ERRORErrorDataWhen an error occurred during the payroll provider connection process
UNSUPPORTED_BROWSERNoneWhen BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Truv and allow you to access their accounts via the Truv. module does not support the user's browser
CLOSECloseDataWhen BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Truv and allow you to access their accounts via the Truv. closes

OpenData

NameTypeDescription
bridge_tokenstringThe bridge_tokenbridge_token - A short-lived token provided by the Truv to authorize the use of Bridge. This token has a 6 hour expiration. value passed to TruvBridge.init.
product_typestringA type of the product. Can be undefined if bridge_tokenbridge_token - A short-lived token provided by the Truv to authorize the use of Bridge. This token has a 6 hour expiration. is expired.
{
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
}

ScreenViewData

NameTypeDescription
view_namestringA name of the BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Truv and allow you to access their accounts via the Truv. screen viewed. Possible values: SELECT_EMPLOYER, PROVIDER_LIST, PROVIDER_LOGIN, PROVIDER_ORG_ID, ERROR, SUCCESS
bridge_tokenstringThe bridge_tokenbridge_token - A short-lived token provided by the Truv to authorize the use of Bridge. This token has a 6 hour expiration. value passed to TruvBridge.init.
product_typestringA type of the product.
{
    "view_name": "PROVIDER_LOGIN",
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income"
}

EmployerSelectedData

NameTypeDescription
bridge_tokenstringThe bridge_tokenbridge_token - A short-lived token provided by the Truv to authorize the use of Bridge. This token has a 6 hour expiration. value passed to TruvBridge.init.
product_typestringA type of the product.
employerobjectAn object with employer data. Contains employer's name.
{
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "employer": {
        "name": "Facebook Demo"
    }
}

TaskData

NameTypeDescription
public_tokenstringA public_tokenpublic_token - A short-lived token used to exchange for an *access_token* from the backend. This token has a 6 hour expiration. that can be exchanged for an access_tokenaccess_token - A private token unique to a single Link. Used to access Link data and initiate any actions using the same Link.
task_idstringA unique identifier associated with an attempt to use a LinkLink - A connection to a payroll provider used to retrieve payroll data. to retrieve payroll data. Include this identifier when opening a support ticket for faster turnaround.
bridge_tokenstringThe bridge_tokenbridge_token - A short-lived token provided by the Truv to authorize the use of Bridge. This token has a 6 hour expiration. value passed to TruvBridge.init.
product_typestringA type of the product.
employerobjectAn object with employer data. Contains employer's name. Can be undefined for the admin product type.
provider_idstringA unique identifier associated with the selected provider.
{
    "public_token": "d80ec8255dc54c5eb7cc03ac05d18ebd",
    "task_id": "2b0e7a7dec1d47678fec4e02af621cc0",
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "provider_id": "adp",
    "employer": {
      "name": "Facebook Demo"
    }
}

ErrorData

NameTypeDescription
errorErrorSee Errors section for the reference
public_tokenstringThe public_tokenpublic_token - A short-lived token used to exchange for an *access_token* from the backend. This token has a 6 hour expiration. associated to this connection attempt. This field will only be available if the error returned is associated to a public_tokenpublic_token - A short-lived token used to exchange for an *access_token* from the backend. This token has a 6 hour expiration..
task_idstringA unique identifier associated with an attempt to use a LinkLink - A connection to a payroll provider used to retrieve payroll data. to retrieve payroll data. Include this identifier when opening a support ticket for faster turnaround.
bridge_tokenstringThe bridge_tokenbridge_token - A short-lived token provided by the Truv to authorize the use of Bridge. This token has a 6 hour expiration. value passed to TruvBridge.init.
product_typestringA type of the product.
{
    "error": {
        "error_code": "LOGIN_ERROR",
        "error_message": "Username or password is incorrect",
        "error_type": "LINK_ERROR"
    },
    "public_token": "d80ec8255dc54c5eb7cc03ac05d18ebd",
    "task_id": "5ad1938450c54024bbc967a3a7dc9020",
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income"
}

CloseData

NameTypeDescription
employerobjectAn object with employer data. Contains employer's name. Can be undefined if no employer was selected.
{
   "employer": {
        "name": "Facebook Demo"
    }
}

Did this page help you?