User login event
The user login event (user:login) must be sent when a user logs in to the system. This event is used in linking a real user ID to a uuid to help in more advanced user personalization use cases, such as cross-device personalization.
The following table lists the properties of the user login event:
|
Name |
Type |
Description |
Value |
|---|---|---|---|
|
|
string |
Required. Type of the event. |
|
|
|
string |
Required. Name of the event. |
|
|
|
object |
Required. User object that contains permanent user information. Used to build a user profile and map a temporary ID ( |
n/a |
|
|
object |
Required if the site is set up with locale configuration. Adds page-specific information (including locale information) under page object. |
n/a |
|
|
object |
Optional. User object. |
n/a |
|
|
object |
Optional. Additional user attributes, such as gender, preference, store code, and so on, that helps in personalization. This could include membership type, loyalty program ID, user profession, and so on. |
n/a |
|
|
object |
Optional. Physical address of the user. Used to derive location affinity. |
n/a |
Sample event specification
The following is an example of a user login event object. This example is in the new format, which means it contains a context object.
{
"type": "user",
"name": "login",
"value": {
"context": {
"user": {
"id": "user-1234",
"email": "[email protected]",
"eid": "<hash_of_email>",
"fbid": "<facebook_id>",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "apartment 123",
"state": "CA",
"zip": "90210",
"country": "US"
},
"gender": "female",
"groups": [
"group1",
"group2"
],
"addn_attributes": {
"email_subscriber": "True",
"preferred_sizes": [
"S",
"M",
"32W",
"30L"
],
"home_store_code": "4321"
}
},
"page": {
"locale_country": "<country code, 2 letters, lowercase, e.g. fr>",
"locale_language": "<language code 2 letters, lowercase, e.g. en>",
"locale_currency": "<currency code, 3 letters, lowercase, e.g. eur>"
}
}
}
}