Identify

Get started with the RudderStack Identify API call.

The identify call allows you to identify a visiting user and associate their actions to that identity. It also lets you record traits about the user like their name, email address, etc.

info
As a best practice, make sure identify is called at the start of every session or page load for logged-in users, if possible. This will ensure all the latest traits are captured.

When should I call identify?

Ideally, you should make an identify call in the following scenarios:

  • After a user registers on your website or app.
  • After a user logs in to your site or app.
  • When a user updates their information, for example, residential address, email ID, etc.
  • (Optional) When you load a page accessible by a logged-in user. This is required only when you have a downstream tool with such requirement (for example, Intercom).

Sample payload

Here is a sample payload for an identify event after removing Common fields:

{
  "type": "identify",
  "context": {
    "traits": {
      "name": "Richard Hendricks",
      "email": "rhedricks@example.com",
      "logins": 2
    }
  },
  "userId": "27340af5c8819"
}

The corresponding event that generates the above payload via the JavaScript SDK is:

rudderanalytics.identify("27340af5c8819", {
  name: "Richard Hendricks",
  email: "rhedricks@example.com",
  logins: 2
})

Send a sample identify call

Use RudderStack’s Event Playground app to send sample events to RudderStack and test the data flow without any instrumentation.

Click Send to see the API call in the Network tab of your browser’s developer tools.

Follow these steps to use the Event Playground app to send test events to your account:

  1. Sign in to the RudderStack dashboard. Note the data plane URLThe data plane URL is the location where events are routed and sent to the RudderStack backend for processing. You can find this URL in the home page of your RudderStack dashboard. at the top of the default Connections page.
Data plane URL
  1. Set up a source and note its write keyThe write key (or source write key) is a unique identifier for your source. RudderStack uses this key to send events from a source to the specified destination. .
JavaScript SDK source write key
  1. Click Use My Account in the Event Playground app below and specify the write key and data plane URL obtained in the above steps.
  1. Click Save.
  2. Select the required API Method from the dropdown. You can also edit the relevant fields or traits/properties.
  3. Click Send to my account to send the event.
  4. Go to the Live Events viewer of your source (set up in Step 2) to verify that the event is successfully received.

Identify fields

The identify call has the following fields in addition to the Common fields:

FieldTypePresenceDescription
userIdStringOptional, if anonymousId is setYour user’s unique identifier. Every identify call requires a userId or an anonymousId.
traitsObjectOptionalIncludes the traits of the user such as their name, email, etc. For more more information, check the Traits section below.
warning

The field names can change slightly depending on the SDK. However, the functionality remains the same.

See the SDK-specific documentation for the implementation specifics and details on the above fields.

User ID vs Anonymous ID

RudderStack requires every identify call to have either a userId or an anonymousId. This section highlights the differences between the two.

User ID

A user ID (userId) uniquely identifies your user in your database. It is a permanent identifier of your customer which never changes - like a database ID.

info
For identify calls, include a userId as often as possible to identify the most up to date traits of the customer.
success
It is recommended to use a database ID as the userId instead of usernames or email addresses. This is because users may update their username or email address at any point in the future. Instead, pass these attributes as traits.

Anonymous ID

There are instances where you may get a visitor on your website/app who may or may not be your customer. Nonetheless, you still want to track their actions and tie them to various events, page views, and traits. In such cases, you should use an Anonymous ID (anonymousId) to identify this user.

info
An anonymousId can be any identifier. For instance, a session ID corresponding to the visitor’s session. If you don’t have a readily available identifier, we recommend generating a UUID.
success
RudderStack’s web and mobile SDKs automatically use anonymous IDs to track unknown users on your website or mobile apps, so you don’t have to worry about including an anonymousId explicitly.

Identify traits

Traits are additional user information included in an identify call. Some examples of traits include age, gender, or some specific details - for example, a user’s product plan (basic, premium, and so on).

info

There are some differences in the way RudderStack captures and sends the user traits across different SDKs. While RudderStack ideally sends the user traits in the context.traits object (as in case of JavaScript SDK), for some SDKs it also sends the user traits in the root-level traits object (for backward compatibility).

Refer to the SDK-specific documentation for more details on sending user traits.

After making an identify call, user traits are not required in subsequent calls. You only need to include changed/updated traits since the last identify call.

RudderStack has some reserved traits that it handles in special ways. These are listed in the table below:

TraitTypeDescription
idStringFallback parameter used only for mapping data if userId is not available in the event payload.
firstNameStringUser's first name
lastNameStringUser's last name
nameString

Full name of the user. If you already passed the firstName and lastName, RudderStack will automatically fill this field.

ageNumberUser's age
emailStringUser's email address
phoneStringUser's phone number
addressObject

User's street address. This can optionally contain either/all of the following fields:

  • city
  • country
  • postalCode
  • state
  • street
birthdayDateUser's date of birth
companyObject

User's company. This can optionally contain either/all of the following fields:

  • name (String)
  • id (String / Number)
  • industry (String)
  • employee_count (Number)
  • plan (String)
createdAtDate

Date of user's account creation. We recommend using the ISO-8601 date string format.

descriptionStringUser's description
genderStringUser's gender
titleString

User's title related to their position in their company

usernameString

User's username. This should be unique for every user.

websiteStringUser's website
avatarStringURL of the user's avatar image
success

Different destinations recognize some of the above traits differently. For example, Mixpanel recognizes createdAt as $created, while Intercom recognizes it as created_at.

With RudderStack, you don’t have to worry about these inconsistencies, it handles these destination-specific conversions automatically.

Passing traits to an identify call

When you pass traits to an identify call, they will be stored in a cookie on the user’s browser or mobile device and will be passed automatically to all subsequent calls.

Below is an example of how to pass traits to an identify call from our JavaScript SDK. For more examples, check our other SDKs.

rudderanalytics.identify("27340af5c8819", {
  name: "Richard Hendricks",
  gender: "male",
})

In the above example, {name: "Richard Hendricks", gender: "male"} are stored in a cookie and passed along with all subsequent calls.

FAQ

How can I achieve consistent identity tracking for users across different top-level domains?

You can leverage the JavaScript SDK’s Query string API to pass the user ID (userId or anonymousId) from one domain to the other so that the user journeys can be stitched together.



Questions? Contact us by email or on Slack