Link Overview
Mesh Link SDK Events
Link Overview
Mesh Link SDK Events
Overview
Mesh Link UI offers an event tracking system, allowing you to gain insights into user interactions within the Link UI. These events can be used for analytics and understanding user behavior. The event data can be obtained directly from the SDKs and includes various user actions, such as initiating a connection, completing authentication, completing an asset transfer, or encountering errors.
The way in which these events are captured and transmitted varies slightly across different platforms (Web, iOS, Android, and React Native). For detailed instructions, see the page for your specific platform.
List of Events
| Event Type | Description of Occurrence | Payload Details |
|---|---|---|
pageLoaded | Triggered when the Link UI page is fully loaded. | No additional payload. |
integrationSelected | Triggered when a user selects an integration from the list. | - integrationType: Type of the integration<>- integrationName: Name of the selected integration |
credentialsEntered | Occurs when a user enters credentials in the Link UI. | No additional payload. Indicates that credentials were entered. |
integrationMfaRequired | Triggered when MFA required to connect integration. | No additional payload. |
integrationMfaEntered | Triggered when user enters MFA code to connect integration. | No additional payload. Indicates that MFA code were entered. |
integrationOAuthStarted | Triggered when OAuth connection flow started. | No additional payload. |
integrationAccountSelectionRequired | Triggered when account selection page showed. | No additional payload. |
integrationConnected | Occurs when a user successfully connects to an integration. | - LinkPayload: Details about the connected integration. |
integrationConnectionError | Fired when there’s an error in connecting to an integration. | - errorMessage: Descriptive error message. |
transferStarted | Fired at the initiation of a financial transfer. | No additional payload. Indicates the start of a transfer. |
transferAssetSelected | Fired when user selects asset to transfer. | - symbol: Currency symbol. |
transferNetworkSelected | Fired when user selects network to transfer. | - id: Selected network identifier name: Selected network name |
transferAmountEntered | Fired when user enters amount to transfer. | No additional payload. |
transferPreviewed | Triggered when a user previews the details of a pending transfer. | - amount: Transfer amount<>- symbol: Currency symbol<>- toAddress: Destination address<>- networkId: Network identifier<>- previewId: Unique ID for the preview<>- networkName (optional): Name of the network<>- amountInFiat (optional): Amount in fiat currency<>- estimatedNetworkGasFee (optional): Object containing fee details |
transferPreviewError | Occurs when there is an error in previewing a transfer. | - errorMessage: Descriptive error message. |
transferMfaRequired | Triggered when MFA required to perform the transfer. | No additional payload. |
transferMfaEntered | Triggered when user enters MFA code to perform the transfer. | No additional payload. |
transferKycRequired | Triggered when KYC flow needed to perform the transfer. | No additional payload. |
transferCompleted | Happens when a financial transfer is successfully completed. | - TransferFinishedPayload: Details about the completed transfer. |
transferExecutionError | Fired when there is an error in executing a transfer. | - errorMessage: Descriptive error message. |
connectionUnavailable | Triggered when a timeout occurred on clicking a deep link (CTA Continue) on a DeFi wallet connect page on mobile, most likely because the DeFi wallet app is not intalled on the device. | - ConnectionUnavailable: integration name and type, the reason. |
connectionDeclined | Triggered when an error occurred on connecting a DeFi wallet on mobile or in a browser due to either a user rejected connection or a network switch. | - ConnectionDeclined: integration name and type, reason, network ID, destination address, error message. |
transferDeclined | Triggered when an error occurred on a Transfer Preview page on mobile or in a browser due to a user rejected the transfer or a transfer failed. | - TransferDeclined: integration name and type, network, destination address, token, amount, status: [‘declined’, ‘failed’] |
walletMessageSigned | Triggered when a user signs to verify wallet ownership. | - address: "0x.....1234" - isVerified: true - message: "Message that was signed" - signedMessageHash: "0x87...cb1b" - timeStamp: 1731950936 |
verifyDonePage | Triggered when user closes verify success page. | No additional payload. |
verifyWalletRejected | Triggered when user rejects wallet verification request | No additional payload. |