Zipy
  • Welcome to Zipy ai
  • Getting Started
    • Install Zipy
    • Installing with Google Tag Manager
    • Supported frameworks
    • Security Overview
    • Sensitive User Data
    • SOC2 Type II
  • Zipy For Mobile
    • React Native Setup
      • Install React Native
      • Input Masking
      • Session Replay
      • Screen Transition Capture
      • Gesture Capturing
      • Unhandled Exception Capture
      • Custom Logging
      • Fetch and XHR Network Calls
      • Profiling
      • Device Information Capture
      • Session URL Retrieval
      • Identify Users
      • Firebase Integration
    • Flutter Setup
      • Install Flutter
      • Session Replay
      • Input Masking & Custom Masking
      • Screen Transition Capture
      • Gesture Capturing
      • Unhandled Exception Capture
      • Custom Logging
      • Http Network Calls
      • Dio Network Calls
      • Profiling
      • Device Information Capture
      • Session URL Retrieval
      • Identify Users
      • Firebase Integration
      • Session Recording Control
      • Data Sanitization
  • iOS Setup
    • Install in an iOS app
    • Identify Users
    • Screen Tracking & Tagging
    • Custom Logging
    • Session URL Retrieval
    • Session Recording Control
    • Input Masking & Custom Masking
  • Chrome Extension
    • Zipy Plug and Play Support
  • Configure
    • Zipy Recording Control
    • Release Version
    • Identifying Users
    • Adding Custom Identifiers
    • Anonymize Users
    • Source Maps
    • Blocking PII data
    • Ignoring Errors/Noise
    • npm Update
    • Support Integration
    • Session Stitching (rootDomain)
  • Product Features
    • Custom Events
    • Session Replay
    • Errors
    • Analytics
    • Time Filters
    • Multiple Filters
    • Clicked Element Filters
    • Manage Teams
    • Stack Trace
    • Console Logs
    • Network Requests
    • Network Headers and Payload
    • Custom Logs
    • Live Users
    • Alerts
      • Slack Alerts
      • Email Alerts
      • Live Alerts
    • Auto Resolve Errors
    • Zipy Labels Plugin
    • iFrame Support
    • API Performance
    • Heatmaps
    • Page Performance
    • Seen/Unseen Sessions
  • FAQs
    • Install Zipy
    • Session Replay Definition
    • Error Tracking
    • Error Classification
    • Environment Support
    • Impact on your App
    • Performance Impact
    • Mobile Support
    • Network Data Capture
    • API Performance Diagnostic Help
      • High DNS Time
      • High SSL Connection Time
      • High Connection Setup Time
      • Large API Response Size
      • High Response Time
      • Compression Not Enabled
      • Server side API Failures
      • Client side API Failures
      • Insecure Connections
  • Troubleshooting
    • Errors in npm
    • Network header missing in Zipy
    • Can't see user data in sessions
    • No recordings or errors visible
    • No network timing split available
  • Product Videos
    • Ask AI
    • Getting Started
    • Session Replay
    • Multiple Project Creation
    • Team Management
    • Alerting on Slack
    • Time Filters and Daily Alerts
    • Custom Identifiers
    • Ignore Errors
    • Identify Users
    • Dashboard
    • Resolve Errors
    • New Error Digest
    • Jira and Slack
    • Online/Offline Network Status
    • Zipy on Zipy
      • Zipy Product Roadmap
  • Whats new
    • Product Updates
  • Legal & Policy
    • Terms of Service
    • Privacy Policy
    • Fulfillment Policy
    • Cookie Policy
    • Acceptable Usage Policy
    • Zipy Sub Processor List
  • Integration
    • Azure DevOps
    • Factors
    • RB2B
    • Webflow
    • WordPress
    • Amplitude
    • Coralogix
    • DevRev
    • Drift
    • Errorception
    • Freshchat
    • Google Analytics
    • Heap
    • HelpScout
    • Honeybadger
    • Hubspot
    • Intercom
    • Mixpanel
    • New Relic
    • Pendo
    • Raygun
    • Rollbar
    • Segment
    • Sentry
    • Shopify
    • Sumo Logic
    • TrackJS
    • Zendesk
Powered by GitBook
On this page
  1. Configure

Identifying Users

How do I identify my users or customers using Zipy?

PreviousRelease VersionNextAdding Custom Identifiers

Last updated 8 months ago

To identify users you will need to additionally call zipy.identify(uuid, {userInfo}). This will help you identify the users of your application by associating your own unique identifier with their activity. This method should typically be called when your users identify themselves by signing in to your application.

Example Usage:

In case you choose to install Zipy in your app with the script tag method, you would first need to include a two line JavaScript SDK provided by Zipy in the <head></head> section of your web app.

<script src="https://storage.googleapis.com/zipy-files/index.standalone.umd.js" crossorigin="anonymous"></script>
<script> window.zipy && window.zipy.init('YOUR_PROJECT_SDK_KEY');</script>
  

After installing Zipy with the script tag, you can associate the recorded sessions with a unique identifier and information of your users. You can do so by adding the following code in your login module or any other source file where your users get successfully authenticated into your application. Given below is an example usage in the code:

window.zipy.identify("cbrandon@brands.com", {
   firstName: "Charles",
   lastName: "Brandon",
   email: "cbrandon@brands.com",
   customerName: "Brands LLC",
   age: "34"
});

To anonymize a previously identified user of your application, use the following code in a source file where users sign out of your application:

window.zipy.anonymize()

In case you choose to install Zipy in your app with the npm method, you would need to install zipy module in the app project as a first step:

npm i zipyai

Then import zipy module and initialize in your _app.js or any other source file:

import zipy from "zipyai";
zipy.init("YOUR_PROJECT_SDK_KEY");  

After integrating Zipy using npm, you can associate the recorded sessions in Zipy with a unique identifier and information of your users. You can do so by adding the following code in your login module or any other source file where your users get successfully authenticated into your application. Given below is an example usage in the code:

import zipy from "zipyai";
zipy.identify("cbrandon@brands.com", {
    firstName: "Charles",
    lastName: "Brandon",
    email: "cbrandon@brands.com"",
    customerName: "Brands LLC",
    age: "34"
});

To anonymize or disassociate a previously identified user of your application from the session, use the following code in a source file where the user signs out of your application:

import zipy from “zipyai”;
zipy.anonymize();

The uuid sent to Zipy can be viewed in the Session Replays list in the user column, as shown in the image below:

The userInfo sent to Zipy can be viewed in the User Environment details in each session replay, as shown in the image below:

zipy.identify(uid, {userInfo})

Following are the Method Parameters:

Name

Description

uuid

A string denoting your unique identifier for your user. Examples of unique identifiers could be UUID, email ID, full name or any other string that uniquely identifies your users.

userInfo

A JSON object which specifies additional details about your user. (Optional)

In addition to the unique identifier sent via uid, the userInfo parameter is a JSON object supporting the key/value pairs mentioned below. You can choose to include one or more of the following information in your userInfo parameter:

  • firstName - String

  • lastName - String

  • email - String

  • customerName - String

  • avatar - String

  • phone - String

  • age - String

Previously identified users of your application can be anonymized by calling the zipy.anonymize() method. This will automatically split the session and associate the new session with a new anonymous user which Zipy will identify with its own identification. This method should typically be called when users sign out of your application.

Zipy now supports two kinds of identifiers - predefined and custom identifiers.

You can read more about custom identifiers here.