User signed up

This event tracks when a user creates an account.

When should you track this event?

Track this event whenever a user signs up. If your application logs users in immediately after signup, also track the sign-in event.

If the user profile does not exist, a new profile is created using provided information. This does not affect existing profiles.

Implementation

Here is an example of how to track this event:

import croct from '@croct/plug';
croct.track('userSignedUp', {  userId: '1ed2fd65-a027-4f3a-a35f-c6dd97537392',   profile: {    firstName: 'Carol',     lastName: 'Doe',     email: 'carol@croct.com',     custom: {      plan: 'pro'    }  }});

Input properties

These are the supported properties:

userId

string

The user's unique identifier provided by the application, such as a UUID or a username.

The value must be between 1 and 100 characters long.

profile(optional)

object

The user profile.

See the user reference for the full list of supported attributes.

Processed properties

These properties are automatically tracked:

externalUserId

string

This property corresponds to the userId property provided in the input.

In the processed event, this property is referred to as userId to distinguish it from the unique identifier assigned internally to each user.

patch(optional)

object

A series of operations derived from the profile input property.

The patch created from the input profile is used internally to reflect changes in the user profile.

Payload examples

Below are some payload examples for this event:

{  "userId": "1ed2fd65-a027-4f3a-a35f-c6dd97537392"}