Skip to content

Payload branch "user"

As You can see this branch holds information about general data (IP address, device, etc.) and the current login status of the User, along with the "customer" definition.

Let's review an example:

js
{
  "context": "...",
  "event": "...",
  "checkout_step": "...",
  "attributes": {...},
  "products": [...],
  "carrier": {...},
  "payment": {...},
  "delivery": {...},
  "billing": {...},
  "user": {
    "ip": "79.26.211.79",
    "origin": "desktop",
    "logged_in": true,
    "customer": {
      "id": 1,
      "email": "f.politi@icoa.it",
      "email_hash": "dcf11fbf911e8345d0a1ce4a78b17817",
      "card_code": "9950002499788",
      "cdp_identity_tier": "novip",
      "cdp_identity_id": 1651
    }
  },
  "engagements": {...}
}

Variables full details

Here you can find a detailed description of each variable or sub-branch:

VarTypeDescription
ipstringIPv4 or IPv6 internet address of the user
originstringWhich device/theme is using the user ("desktop" or "mobile")
logged_inboolUser's login status
customerobject/nullIf the user is logged-in, it holds general info about the "customer"

Object: "customer"

This object holds informations about the logged-in User (Customer), and it is always defined with these variables:

VarTypeDescription
idintInternal customer unique ID (NOT cross-tenant)
emailstringPlain customer's email address (cross-tenant)
email_hashstringPlain customer's email address, as MD5 hash (cross-tenant)
card_codestring/nullFidelity card code (cross-tenant)
cdp_identity_tierstring/nullFidelity tier as last stated bu the CDP
cdp_identity_idstring/nullCDP identity unique ID (cross-tenant)

Released under the MIT License.