Login

Reports that the user completed the signup process and is a registered user. Identification event.

👍

Use this event similarly to the Signup event

Both identify a user. Use Login to identify an already-registered user, and use Signup to report a new user registration. Read the guide section about Events Identifying a Customer Across Channels for more information.

The registered customer unique ID (CUID) you pass in this event can be either a hashed email address or a custom type. You can:

  • Report the event with a hashed email address, enabling you to use email features (and onboard first-party data, for which the primary key is typically the hashed email address).
  • Report the event with a non-email CUID type. Specify the type by setting the cuidType property. For example, pass crmId to designate identifiers created internally in your CRM. If cuidType is not set, a default named id type is used.
  • If you report the event without any identifier, it simply tracks that a login occurred but not by whom. It registers a warning in your implementation health report, but the event still serves for tracking and targeting purposes.

Parameters

  • name: Human-readable name, not used to identify an event type
  • properties: A container for the event properties as specified in the following table:
PropertyDescriptionType
dyTypeMust be "login-v1"String
cuid
Optional
User identifier value.
! Must not include a / character
String
cuidType

Optional
Use this identifier type to identify users across devices (for example, customer_id or account_id). Note: Do not include any personal information in this ID.String
secondaryIdentifiers
type, value
Optionally, add a phone number as a second method for identification across devices and Experience OS apps. Note: Phone number must be E.164 format (+ and country code and phone number, no spaces or symbols. For example, +12195551212, +49555343333.)String
hashedEmail
Optional
SHA-256 encoding of the lowercase email address. You can use this identifier type instead of cuid and cuidType.String

📌

Using the secondary identifier

As soon as you report a secondary identifier for a user, that ID is mapped to the user no matter which device is used or which event is reported. Until it's overriden with a new value, it exists for the user whether or not it's re-reported in an API or script-based event.

Example: Implementation via script, using hashed email address

DY.API("event", {
  name: "Login",
  properties: {
    dyType: "login-v1",
    hashedEmail: DYO.dyhash.sha256("[email protected]".toLowerCase()), // SHA256 encoding of the lowercase email.
  }
});

Example: Implementation via script, using cuid

DY.API("event", {
  name: "Login",
  properties: {
    dyType: "login-v1",
    cuid: "156498191",
    cuidType: "EcommerceID"
  }
});

Example: Implementation via script, using secondary identifier

DY.API("event", {
  name: "Login",
  properties: {
    dyType: "login-v1",
    cuid: "156498191",
    cuidType: "he",
    secondaryIdentifiers: [
      {type: "phoneNumber", value: "+972503803434"},
    ]
  }
});

Example: Implementation via Experience API (server-side), using hashed email address

"events": [
        {
          "name": "Login",
          "properties": {
            "dyType": "login-v1",
            "hashedEmail": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1"
          }
        }
      ]

Example: Implementation via Experience API (server-side), using cuid

"events": [
        {
          "name": "Login",
          "properties": {
            "dyType": "login-v1",
            "cuidType": "clientId", //You can use any type you want to
            "cuid": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1"
          }
        }
      ]

Example: Implementation via Experience API (server-side), using secondary identifier

"events": [
        {
          "name": "Login",
          "properties": {
            "dyType": "login-v1",
            "cuid": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1",          
            "cuidType": "he", //You can use any type you want to
            "secondaryIdentifiers": [
              {type: "phoneNumber", value: "+972503803434"},
             ]
          }
        }
      ]

👍

Go to the API reference for the Events endpoint to learn more.