Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore Personalize
Data privacy
Before you start sending data
Integrating with Sitecore Personalize
Stream API
Personalize API Flow execution
REST APIs
  • Sitecore Personalize for developers
  • Stream API
  • Sitecore Engage SDK reference
  • Functions
  • Engage.identity(eventData[, extensionData])

Engage.identity(eventData[, extensionData])

The identity() function sends an IDENTITY event. The IDENTITY event is used to resolve the identity of an anonymous user of your app and turn them into a known user.

sidebar. Parameters

Parameter

Type

Description

eventData

object

All the event data.

[extensionData]

optional

object

Custom data about an event.

Maximum 50 custom attributes of your choice.

Here's an example of how to use the identity() function to send the email address that a user enters in a form. In a React app, you can capture form data using the State Hook.

components/Form.jsx:

RequestResponse
import { useState } from "react";
import { engage } from "../engage";

export default function Form() {
    const [email, setEmail] = useState("");

    const handleEmail = (e) => {
        setEmail(e.target.value);
    };

    const handleSubmit = async (e) => {
        e.preventDefault();

        const eventData = {
          channel: "WEB",
          currency: "EUR",
          pointOfSale: "myretailsite/ireland",
          language: "EN",
          page: "home",
          email,
          identifiers: [
              {
                  id: "123456",
                  provider: "BXLP"
              }
          ]
        };

        const extensionData = {
          customKey: "customValue"
        };
        
        // Send IDENTITY event to Sitecore Personalize
        await engage.identity(eventData, extensionData);
    };

    return (
        <form onSubmit={handleSubmit}>
            <label>
                <span>Email:</span>
                <input type="text" onChange={handleEmail} value={email} />
            </label>

            <button>Subscribe</button>
        </form>
    )
};

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2025 Sitecore