Events
onEvent types
Event Type | Event Payload | Description |
---|---|---|
LOAD | None | When 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 |
OPEN | OpenData | When 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_VIEW | ScreenViewData | When 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_SELECTED | EmployerSelectedData | When employer was selected in the Bridge |
LINK_CREATED | TaskData | When a user attempts to log in to their payroll provider |
LOGIN_COMPLETED | TaskData | When a user successfully logs in to their payroll provider |
SUCCESS | TaskData | When a user's data successfully retrieved from their payroll provider |
ERROR | ErrorData | When an error occurred during the payroll provider connection process |
UNSUPPORTED_BROWSER | None | When 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 |
CLOSE | CloseData | When 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
Name | Type | Description |
---|---|---|
bridge_token | string | The 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_type | string | A 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
Name | Type | Description |
---|---|---|
view_name | string | A 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_token | string | The 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_type | string | A type of the product. |
{
"view_name": "PROVIDER_LOGIN",
"bridge_token": "b5cb1933e43043a792a9b337af5824e2",
"product_type": "income"
}
EmployerSelectedData
Name | Type | Description |
---|---|---|
bridge_token | string | The 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_type | string | A type of the product. |
employer | object | An object with employer data. Contains employer's name. |
{
"bridge_token": "b5cb1933e43043a792a9b337af5824e2",
"product_type": "income",
"employer": {
"name": "Facebook Demo"
}
}
TaskData
Name | Type | Description |
---|---|---|
public_token | string | 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. 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_id | string | A 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_token | string | The 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_type | string | A type of the product. |
employer | object | An object with employer data. Contains employer's name. Can be undefined for the admin product type. |
provider_id | string | A 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
Name | Type | Description |
---|---|---|
error | Error | See Errors section for the reference |
public_token | string | The 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_id | string | A 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_token | string | The 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_type | string | A 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
Name | Type | Description |
---|---|---|
employer | object | An object with employer data. Contains employer's name. Can be undefined if no employer was selected. |
{
"employer": {
"name": "Facebook Demo"
}
}
Updated 23 days ago
Did this page help you?