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.
This event can be used with or without passing a registered customer unique ID (CUID). The CUID can be either a hashed email or any custom type. The following are your choices of what to include when sending this event:
- Report the event with a hashed email, enabling you to use email features (and onboarding of first-party data, for which the primary key is typically hashed email).
- Report the event with a non-email CUID type. In this case, you can 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.
- Send both an email address AND a non-email identifier. In this case, both will be linked to each other.
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 (customer ID) | 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 |
hashedEmail Optional | SHA-256 encoding of the lowercase email address. You can use this identifier type instead of cuid and cuidType. | String |
phoneNumber Optional | You can add the user’s phone number as another identification property. Can be used for triggering SMS campaigns. | A phone number (national and local numbers) in E.164 format. |
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.
phoneNumber:"+972503803434"
}
});
Example: Implementation via script, using cuid
DY.API("event", {
name: "Signup",
properties: {
dyType: "signup-v1",
cuid: "156498191"
cuidType: "EcommerceID"
phoneNumber:"+972503803434"
}
});
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 cuid
״events״:[
{
"name": "Signup",
"properties": {
"dyType": "signup-v1",
"cuidType": "clientId", //You can use any type you want to
"cuid": "62eccc43b550b012b7ea7fb07e64baafb1508d8b715a55148ccf0f3322eab1a1"
}
}
]