Signup
Reports that the user completed the signup process and is a registered user. Identification event.
Use this event similarly to the Login 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 signup 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:
Property | Description | Type |
---|---|---|
dyType | Must be "signup-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 , account_id , or he ). 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. Available types/values include: Script-based event: Type: phoneNumber , Value: Phone numberMust be E.164 format (+ and country code and phone number, no spaces or symbols. For example, +12195551212, +49555343333.) API-based event: Type: hashedPhoneNumber , Value: SHA-256 hashed phone number | 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.
TIP: Using
hashedEmail
instead ofcuid
andcuidType
You can use a sort of "shorthand" in your event code to replace these 2 properties with a single one if the CUID type is hashed email address. See examples that follow for how this can look.
hashedEmail
OptionalSHA-256 encoding of the lowercase email address. You can use this identifier type instead of cuid and cuidType. String
Example: Implementation via script, using cuid
DY.API("event", {
name: "Signup",
properties: {
dyType: "signup-v1",
cuid: "156498191",
cuidType: "EcommerceID"
}
});
Example: Implementation via script, using hashed email address
DY.API("event", {
name: "Signup",
properties: {
dyType: "signup-v1",
hashedEmail: DYO.dyhash.sha256("[email protected]".toLowerCase()), // SHA256 encoding of the lowercase email.
}
});
Example: Implementation via script, using secondary identifier
DY.API("event", {
name: "Signup",
properties: {
dyType: "signup-v1",
cuid: "156498191",
cuidType: "he",
secondaryIdentifiers: [
{type: "phoneNumber", value: "+972503803434"},
]
}
});
Example: Implementation via Experience API (server-side), using cuid
"events":[
{
"name": "Signup",
"properties": {
"dyType": "signup-v1",
"cuidType": "clientId", //You can use any type you want to
"cuid": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1"
}
}
]
Example: Implementation via Experience API (server-side), using hashed email address
"events":[
{
"name": "Signup",
"properties": {
"dyType": "signup-v1",
"hashedEmail": "43e62d636651bc44edcd528a510d57ce69126cd875c..."
}
}
]
Example: Implementation via Experience API (server-side), using secondary identifier
"events":[
{
"name": "signup",
"properties": {
"dyType": "signup-v1",
"cuid: "156498191",
"cuidType": "he", //You can use any type you want to
"secondaryIdentifiers:: [
{type: "hashedPhoneNumber", value: "49c7b1f6d24121078d8f37997b433586fe9a28e2dc4fbd0803eac237ac82255e"},
]
}
}
]
Go to the API reference for the Events endpoint to learn more.
Updated 17 days ago