Author: Vendrux

The nativeFunctions.klaviyoMergeProfiles() function allows you to merge user profiles across mobile app and website platforms in Klaviyo. This function should only be called in Canvas-based environments.

External User ID Usage

// Check if the user agent contains 'canvas' (case-insensitive)
if (navigator.userAgent.toLowerCase().includes('canvas')) {
  try {
    // Merge profile using external ID
    nativeFunctions.klaviyoMergeProfiles('user123', null)
  } catch (error) {
    // Handle any potential errors
    console.error('Profile merge failed:', error)
  }
}

Email Usage

// Check if the user agent contains 'canvas' (case-insensitive)
if (navigator.userAgent.toLowerCase().includes('canvas')) {
  try {
    // Merge profile using email
    nativeFunctions.klaviyoMergeProfiles(null, 'user@example.com')
  } catch (error) {
    // Handle any potential errors
    console.error('Profile merge failed:', error)
  }
}

Profile Merge Mechanism

User Existence Verification

The klaviyoMergeProfiles() function performs an internal check to determine the user’s existence in Klaviyo before initiating the merge process. This means:

• The merge is only triggered if a matching user profile is found
• If no existing user is detected, no merge action occurs
• This ensures data integrity and prevents unnecessary profile modifications

Post-Merge User Information Update

After a successful profile merge, the app automatically updates the external user ID in the userInfo object. This process ensures:

• The most recent and accurate user identification
• Synchronization between the app’s internal user tracking and Klaviyo’s profile system
• Consistent user data across different platforms and touchpoints

More details can be found here: https://www.vendrux.com/docs/get-user-information

Why the User Agent Check?

• Ensures the function is only called in the intended Vendrux based environment
• Prevents errors in non-supported platforms
• Provides a safeguard against unintended function calls

Function Signature

nativeFunctions.klaviyoMergeProfiles(externalID, email)

Parameters

• externalID (Optional): A unique identifier for the user
• email (Optional): The user’s email address

Important Notes

• You must provide at least one of the two parameters
• Do not pass both externalID and email simultaneously
• The function will only execute if the user agent contains “canvas”

Best Practices

• Always wrap nativeFunctions.klaviyoMergeProfiles() in a user agent check
• Use toLowerCase() to ensure case-insensitive matching
• Implement robust error handling
• Log merge operations for tracking

Potential Pitfalls to Avoid

• Calling the function without a user agent check
• Passing both parameters simultaneously
• Ignoring potential merge errors

‍

Vendrux’s Klaviyo integration includes several native functions that allow you to manage user profiles and attributes with ease. In this guide you will find a list of available functions with examples and more details on how to use them.

klaviyoSetExternalUserId

This function sets a new external ID for a user profile and deactivates any old profiles associated with the previous external ID.

Example:

	nativeFunctions.klaviyoSetExternalUserId('12345')

klaviyoSetEmail

This function sets the email address for a user profile.

Example:

	nativeFunctions.klaviyoSetEmail('john@gmail.com')

klaviyoSetPhoneNumber

This function sets the phone number for a user profile.

Example:

	nativeFunctions.klaviyoSetPhoneNumber('+3059999999')

klaviyoSendAttributes

This function sets the specified attributes as true for a user profile.

Example:

	nativeFunctions.klaviyoSendAttributes(['tag_name'])

klaviyolDeleteAttributes

This function sets the specified attributes as false for a user profile.

Example:

	nativeFunctions.klaviyolDeleteAttributes(['tag_name'])

klaviyoSetAttributes

This function sets attributes with custom values for a user profile. Ensure you use JSON.stringify() to format the values correctly.

Example:

	nativeFunctions.klaviyoSetAttributes(JSON.stringify({'tag_name_1': false, 'tag_name_2': true}))