Identify User

Associates a user with traits via the identify() call. userId is optional — omit it for anonymous users and the SDK will use its own anonymousId.

Code Example

Segment (JS)

analytics.identify("usr_12345", {
  "email": "jane@example.com",
  "name": "Jane Doe",
  "plan": "free",
  "created_at": "2024-01-15T10:30:00Z"
});

RudderStack (JS)

rudderanalytics.identify("usr_12345", {
  "email": "jane@example.com",
  "name": "Jane Doe",
  "plan": "free",
  "created_at": "2024-01-15T10:30:00Z"
});

Hightouch (JS)

htevents.identify("usr_12345", {
  "email": "jane@example.com",
  "name": "Jane Doe",
  "plan": "free",
  "created_at": "2024-01-15T10:30:00Z"
});

Event Properties

Property	Type	Constraints	Examples	Description
$schema	string	required	"https://tracking-docs-demo.buchert.digital/schemas/analytics-js/identify-user.json"	Defines the structure of the event.
		const: "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/identify-user.json"
userId	string		"usr_12345" "user@example.com"	The unique identifier for the user in your database. Optional — omit for anonymous users.
email	string		"jane@example.com" "john.doe@company.com"	The email address of the user.
name	string		"Jane Doe" "John Smith"	The full name of the user.
plan	string	enum: [free, pro, enterprise]	"free" "pro" "enterprise"	The subscription plan of the user.
created_at	string		"2024-01-15T10:30:00Z" "2023-06-01T00:00:00Z"	ISO 8601 timestamp of when the user account was created.

View Raw JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/identify-user.json",
  "title": "Identify User",
  "description": "Associates a user with traits via the identify() call. userId is optional — omit it for anonymous users and the SDK will use its own anonymousId.",
  "x-tracking-targets": [
    "web-segment-js",
    "web-rudderstack-js",
    "web-hightouch-js"
  ],
  "x-method": "identify",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string",
      "description": "Defines the structure of the event.",
      "const": "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/identify-user.json"
    },
    "userId": {
      "type": "string",
      "description": "The unique identifier for the user in your database. Optional — omit for anonymous users.",
      "examples": [
        "usr_12345",
        "user@example.com"
      ]
    },
    "email": {
      "type": "string",
      "description": "The email address of the user.",
      "examples": [
        "jane@example.com",
        "john.doe@company.com"
      ]
    },
    "name": {
      "type": "string",
      "description": "The full name of the user.",
      "examples": [
        "Jane Doe",
        "John Smith"
      ]
    },
    "plan": {
      "type": "string",
      "description": "The subscription plan of the user.",
      "enum": [
        "free",
        "pro",
        "enterprise"
      ],
      "examples": [
        "free",
        "pro",
        "enterprise"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "ISO 8601 timestamp of when the user account was created.",
      "examples": [
        "2024-01-15T10:30:00Z",
        "2023-06-01T00:00:00Z"
      ]
    }
  },
  "required": [
    "$schema"
  ]
}