Tracking

Capture how users interact with Link.

Overview#

You can track user behavior in Link by including the onUIEvent callback in your Link initialization.

The onUIEvent callback is triggered for specific UI events in Link, and although optional, including this callback can help with troubleshooting as well as optimizing conversion rates.

Callback format#

Add the line below to your Link initialization:

1onUIEvent: (payload) => console.log('onUIEvent', payload);

Callback payload#

The onUIEvent callback returns:

1. The name of the UI-related Event that triggered the callback.
2. A properties object, which can include:
   • deepLink (always) — Whether the user was directly connected to the Item.
   • itemId (conditional) — ID of the relevant Item.
   • accountId (conditional) — ID of the user's account.
   • Event-specific properties (conditional) — See Events below.

Example:

1UIEvent (
2    "name": "mfa - opened",
3    "properties": {
4        "deepLink": false,
5        "itemId": "item_123456789",
6        "type": "Login",
7        "mfaType": "sms_code"
8    }
9)

Events#

Intro screen#

Search screen#

Property definitions:

• term — The text entered in the search field.
  
• tab — The tab that was open when the user entered a search term or selected an Item. Ignored for empty (or deleted) search terms. Possible values: Popular, Payroll providers, Employers

Login screen#

Property definitions:

• errorCode — The account connection error relevant to the login screen that occurred. Possible values: auth_required, expired_credentials, invalid_auth, invalid_credentials, invalid_login_method, mfa_timeout
• errorMessage — The account connection error message shown to the user.

MFA screen#

Property definitions:

• type — Whether MFA occurred during login or a deposit switch. Possible value: Login, DDS
• mfaType — The type of MFA. Possible values: sms_code, email_code, secret_question, email_link_confirmation, otp_code, email_message_confirmation

Success screen#

Account status screen#

Direct deposit opened screen#

Property definitions:

• allocationType — Which type of pay allocation was shown to the user. Possible values: percent, amount, none

Allocation type selection screen#

Direct deposit success screen#

Account error screen#

Property definitions:

• connectionStatus — The connection.status of the Account.
• connectionErrorCode — The account connection error that occurred.
• ddsStatus - The direct_deposit_switch.status of the Account.
• ddsErrorCode - The deposit switching error that occurred.

Link error screen#

Property definitions:

• errorType — The Link error that occurred.

Link closed#

Occurs when the user closes Link from any screen.