---
title: "User login event"
slug: "user-login-event"
abstract: "Explains composition and usage of the Sitecore Discover user login event object."
---
# 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](https://doc.sitecore.com/discover/en/developers/discover-developer-guide/integrate-using-discover-rest-apis/events-data-model/event-specifications/funnel-events/tracking-site-visitor-information.md "Tracking site visitor information") 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 |
| --- | --- | --- | --- |
| `type` | string | Required.<br><br>Type of the event. | `user` |
| `name` | string | Required.<br><br>Name of the event. | `login` |
| `value.context.user` | object | Required.<br><br>[User object](https://doc.sitecore.com/discover/en/developers/discover-developer-guide/integrate-using-discover-rest-apis/events-data-model/event-specifications/funnel-events/the-user-object.md "The user object") that contains permanent user information. Used to build a user profile and map a temporary ID (`uuid` or `user_id`) to the user's permanent identifier. Enables cross-device personalization. | n/a |
| `value.context.page` | object | Required if the site is set up with locale configuration.<br><br>Adds page-specific information (including locale information) under [page object](https://doc.sitecore.com/discover/en/developers/discover-developer-guide/integrate-using-discover-rest-apis/events-data-model/event-specifications/funnel-events/the-page-object.md "The page object"). | n/a |
| `value.user` (deprecated) | object | Optional.<br><br>[User object](https://doc.sitecore.com/discover/en/developers/discover-developer-guide/integrate-using-discover-rest-apis/events-data-model/event-specifications/funnel-events/the-user-object.md "The user object"). `value.user` is deprecated. We recommend that you use `value.context.user` for permanent user information. | n/a |
| `value.user.addn_attributes` (deprecated) | object | Optional.<br><br>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. `value.user` is deprecated. We recommend that you use `value.context.user` for user information. | n/a |
| `value.user.address` (deprecated) | object | Optional.<br><br>Physical address of the user. Used to derive location affinity. `value.user` is deprecated. We recommend that you use `value.context.user` for user information. | 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.

```JSON
{
  "type": "user",
  "name": "login",
  "value": {
    "context": {
      "user": {
        "id": "user-1234",
        "email": "abc.def@email.com",
        "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>"
      }
    }
  }
}
```