Send an IDENTITY event to Sitecore CDP

Abstract

Provides the required attributes and a JSON example of how to send an IDENTITY event to Sitecore CDP (Data model 2.1).

All events that are passed to Sitecore CDP using the Stream API are attributed to a guest using the identifiers object.

Warning

Stream API does not support using Personally Identifiable Information for identifying guests.

In the Sitecore CDP 2.1 data model, the Stream API only supports using the identifiers object to identify guests. The Stream API does not support sending PII in an IDENTITY event to perform identity. You can send PII as supplementary, optional data.

You must capture IDENTITY events wherever in the site that the guest provides data that might help identify them. It is common for a single browser session to have multiple IDENTITY events.

To send an IDENTITY event, use the following attributes:

Attribute	Description	Type	Example(s)	Required/optional
`channel`	The channel captured on each page the guest visited.	string (uppercase)	`"WEB", "MOBILE_WEB", "MOBILE_APP"`	Required
`type`	The type of event.	string (uppercase)	`"IDENTITY"`	Required
`language`	The language captured on each page the guest visited.	string (2 letter ISO 639 language code)	`"EN"`	Required
`currency`	The type of currency.	string (3 letter ISO 4217)	`"EUR"`	Required
`page`	The name of the webpage the guest visited.	string	`"home page", "search page", "/home", "/confirm"`	Required
`pos`	The point of sale (storefront) captured on each page the guest visited.	string (predefined by client)	`"retailsite123.com", "myretailsite456.co.uk"`	Required
`browser_id`	The ID of a browser generated by Sitecore CDP.	string (UUID)	`"56860bff-94ba-4d84-aa37-2b5a83d5411b"`	Required
`email`	The email address of the guest.	string (suggest lowercase)	`"johndoe@gmail.com"`	Optional
`title`	The title of the guest.	string (title case)	`"Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lady", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"`	Optional
`firstname`	The first name of the guest.	string (suggest title case)	`"John"`	Optional
`lastname`	The last name of the guest.	string (suggest title case)	`"Smith"`	Optional
`gender`	The gender of the guest.	string	`"male"`	Optional
`dob`	The date of birth of the guest.	ISO 8601 date time ‘YYYY-MM-DD’T’hh:mm’	`"1985-08-23T00:00"`	Optional
`mobile`	The mobile number of the guest.	string	`"+3531234567"`	Optional
`phone`	The phone number of the guest.	string	`"+353123456"`	Optional
`street`	The street address of the guest.	array of strings (suggest title case)	`"Tara Street"`	Optional
`city`	The city address of the guest.	string (suggest title case)	`"Dublin"`	Optional
`state`	The state address of the guest.	string (suggest title case)	`"Oregon"`	Optional
`country`	The country address of the guest.	ISO 3166-1 country code (uppercase)	`"IE"`	Optional
`postal_code`	The postal code of the guest.	string	`"D2"`	Optional
`identifiers`	The JSON array of objects that contain the identity identifiers provided by your organization.	A JSON array of objects	N/A	Required
`identifiers.provider`	The name of the organization's identity system, external to Sitecore CDP, that provided the unique identifier.	string	`"BXLP"`	Required
`identifiers.id`	The unique guest identifier from the organization's identity system, such as a Customer Relationship Management (CRM) system.	string	`"123456"`	Required
`identifiers.expiry_date`	The date the guest's unique ID is set to expire, according to the customer's identity system, such as a CRM system.	ISO 8601 date/time UTC	`"2022-12-31T00:00"`	Optional

The following JSON example demonstrates how to send an IDENTITY event to Sitecore CDP:

{
    "channel": "WEB",
    "type": "IDENTITY",
    "language": "EN",
    "currency": "EUR",
    "page": "home page",
    "pos": "retailsite123.com",
    "browser_id": "56860bff-94ba-4d84-aa37-2b5a83d5411b",
    "identifiers": [{
        "provider": "BXLP",
        "id": "123456"
    }]
}