Funnel events

User info event

The user info event (user:info) must be sent whenever user information is updated or when user information is available to be sent, such as when it is accessed in a customer system. This event is used in linking a real user ID to a uuid to help in more advanced use cases such as cross-device personalization.

The following table lists the properties of the user info event:

Name	Type	Description	Value
`type`	string	Required. Type of the event.	`user`
`name`	string	Required. Name of the event.	`info`
`value.context.user`	object	Required. 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. Adds page-specific information (including locale information) under page object.	n/a

Sample event specification

The following is an example of a user info event object. This example is in the new format, which means it contains a context object.

{
  "type": "user",
  "name": "info",
  "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>"
      }
    }
  }
}

If you have suggestions for improving this article, let us know!