Adding Custom Identifiers

How do I add custom identifiers when using zipy.identify()?

To identify users, we provide you with the zipy.identify() function in our SDK. You can read more about this here. Zipy now supports two kinds of identifiers - predefined and custom identifiers.

Predefined identifiers

You can use one or more of the following predefined identifiers when you call zipy.identify():

  • firstName - String

  • lastName - String

  • email - String

  • customerName - String

  • avatar - String

  • phone - String

  • age - String

Custom identifiers

We allow a maximum of 10 custom identifiers per project which can be created as per your use-case. To use custom identifiers, you can add them to the existing userInfo JSON in Zipy’s identify method:

zipy.identify(uid, [userInfo])

Example Usage:

To uniquely identify your users with Zipy using your own custom identifiers e.g. “city”, “state” & “country”, update your existing zipy.identify method as given below:

window.zipy.identify("", {
   firstName: "John",
   lastName: "Doe",
   email: "",
   customerName: "Your Company",
   age: "34",
   city:  "Los Angeles",
   state: "California",
   country: "United States of America"

In case your custom identifier key has a special character (space, - , _ etc), please quote the key within double quotes inside the JSON e.g.:

"emp_city": "Los Angeles"

This userInfo including the custom identifiers will be captured by Zipy and can be viewed in the User Environment details in each user session, as shown in the image below:

The custom identifiers can also be used to filter your sessions & errors.

In case you want to add your own custom identifiers in addition to the identifiers we have defined for you, please raise a support ticket with the list of custom identifier names for your project so that we can add them for you. Alternatively, you can use the chat widget in the Zipy application for the required support.

Last updated