Click

Events categorized under the click level are utilized to monitor and analyze user interactions within the storefront. For instance, tracking when a user adds a product to the cart or initiates a login process.

User login

This event is triggered when a user logs into the storefront. It captures details such as login method, user device, and timestamp, providing insights into user authentication and behavior.

Events

click/user_login/identity/v1

# This event is triggered when a user logs into their account on the storefront. It includes detailed information about the user and the environment from which the login occurs.

User Login/user_login/identity/v1

This event is triggered when a user logs into their account on the storefront. It includes detailed information about the user and the environment from which the login occurs.

Payload

Properties

Event emitted when a user logs into their account on the storefront.

context

object

Required

Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.

Properties

library

object

Required

Library information which is sending the event.

Properties

name

string

Required

Name of the library sending the event.

version

string

Required

Version of the library.

object

Required

Operating system details for the user device.

Properties

name

string

Required

OS name.

version

string

Required

OS version.

timezone

string

Required

User's timezone.

screen

object

Required

Screen resolution details.

Properties

width

integer

Required

Screen width in pixels.

height

integer

Required

Screen height in pixels.

user_agent

string

Required

User agent information.

locale

string

Required

User's locale information.

device

object

Required

User's device details.

Properties

is_mobile

boolean

Required

Indicates if the device is mobile or not.

event_id

string

Required

Unique identifier for the event.

event_name

string

Required

Name of the event (e.g., "user_login").

version

string

Required

Version of the event schema.

event_type

string

Required

Type of the event (e.g., "engagement").

Enum

method

string

Required

Method used for login (e.g., "email", "mobile").

Enum

phone

object|string

Phone number used for login.

Properties

phone

string

Required

User's phone number.

active

boolean

Required

Indicates if the phone number is active.

primary

boolean

Required

Indicates if this is the primary phone number.

verified

boolean

Required

Indicates if the phone number is verified.

country_code

integer

Required

Country code of the phone number.

login_value

string

Required

Value used by the user for login. This could be either user's email or phone number.

company_id

integer

Required

ID of the company.

company_mode

string

Required

Mode of the company (e.g., "live", "development").

Enum

company_created_on

string

| date-time

Required

Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.

event_timestamp

string

| date-time

Required

Timestamp of the event.

user_id

string|null

Identifier of the user performing the user login action. Use `null` if the user is anonymous.

anonymous_id

string

Required

Anonymous identifier assigned to the user if they are not logged in.

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "context",
5    "event_id",
6    "event_name",
7    "event_timestamp",
8    "anonymous_id",
9    "event_type",
10    "company_id",
11    "company_mode",
12    "company_created_on",
13    "version",
14    "method",
15    "login_value"
16  ],
17  "description": "Event emitted when a user logs into their account on the storefront.",
18  "properties": {
19    "context": {
20      "type": "object",
21      "description": "Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.",
22      "properties": {
23        "library": {
24          "type": "object",
25          "description": "Library information which is sending the event.",
26          "properties": {
27            "name": {
28              "type": "string",
29              "description": "Name of the library sending the event.",
30              "example": "flick"
31            },
32            "version": {
33              "type": "string",
34              "description": "Version of the library.",
35              "example": "1.1.1"
36            }
37          },
38          "required": [
39            "name",
40            "version"
41          ]
42        },
43        "os": {
44          "type": "object",
45          "description": "Operating system details for the user device.",
46          "properties": {
47            "name": {
48              "type": "string",
49              "description": "OS name.",
50              "example": "Mac OS"
51            },
52            "version": {
53              "type": "string",
54              "description": "OS version.",
55              "example": "10.15.7"
56            }
57          },
58          "required": [
59            "name",
60            "version"
61          ]
62        },
63        "timezone": {
64          "type": "string",
65          "description": "User's timezone.",
66          "example": "Asia/Calcutta"
67        },
68        "screen": {
69          "type": "object",
70          "description": "Screen resolution details.",
71          "properties": {
72            "width": {
73              "type": "integer",
74              "description": "Screen width in pixels.",
75              "example": 1512
76            },
77            "height": {
78              "type": "integer",
79              "description": "Screen height in pixels.",
80              "example": 859
81            }
82          },
83          "required": [
84            "width",
85            "height"
86          ]
87        },
88        "user_agent": {
89          "type": "string",
90          "description": "User agent information.",
91          "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36"
92        },
93        "locale": {
94          "type": "string",
95          "description": "User's locale information.",
96          "example": "en-GB"
97        },
98        "device": {
99          "type": "object",
100          "description": "User's device details.",
101          "properties": {
102            "is_mobile": {
103              "type": "boolean",
104              "description": "Indicates if the device is mobile or not.",
105              "example": false
106            }
107          },
108          "required": [
109            "is_mobile"
110          ]
111        }
112      },
113      "required": [
114        "library",
115        "os",
116        "timezone",
117        "screen",
118        "user_agent",
119        "locale",
120        "device"
121      ]
122    },
123    "event_id": {
124      "type": "string",
125      "description": "Unique identifier for the event."
126    },
127    "event_name": {
128      "type": "string",
129      "description": "Name of the event (e.g., \"user_login\")."
130    },
131    "version": {
132      "type": "string",
133      "description": "Version of the event schema."
134    },
135    "event_type": {
136      "type": "string",
137      "description": "Type of the event (e.g., \"engagement\").",
138      "enum": [
139        "engagement",
140        "click",
141        "conversion",
142        "impression",
143        "search",
144        "identity"
145      ]
146    },
147    "method": {
148      "type": "string",
149      "description": "Method used for login (e.g., \"email\", \"mobile\").",
150      "enum": [
151        "email",
152        "mobile"
153      ]
154    },
155    "phone": {
156      "type": [
157        "object",
158        "string"
159      ],
160      "description": "Phone number used for login.",
161      "properties": {
162        "phone": {
163          "type": "string",
164          "description": "User's phone number."
165        },
166        "active": {
167          "type": "boolean",
168          "description": "Indicates if the phone number is active."
169        },
170        "primary": {
171          "type": "boolean",
172          "description": "Indicates if this is the primary phone number."
173        },
174        "verified": {
175          "type": "boolean",
176          "description": "Indicates if the phone number is verified."
177        },
178        "country_code": {
179          "type": "integer",
180          "description": "Country code of the phone number."
181        }
182      },
183      "required": [
184        "phone",
185        "active",
186        "primary",
187        "verified",
188        "country_code"
189      ]
190    },
191    "login_value": {
192      "type": "string",
193      "description": "Value used by the user for login. This could be either user's email or phone number."
194    },
195    "company_id": {
196      "type": "integer",
197      "description": "ID of the company."
198    },
199    "company_mode": {
200      "type": "string",
201      "description": "Mode of the company (e.g., \"live\", \"development\").",
202      "enum": [
203        "live",
204        "development"
205      ]
206    },
207    "company_created_on": {
208      "type": "string",
209      "format": "date-time",
210      "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."
211    },
212    "event_timestamp": {
213      "type": "string",
214      "format": "date-time",
215      "description": "Timestamp of the event."
216    },
217    "user_id": {
218      "type": [
219        "string",
220        "null"
221      ],
222      "description": "Identifier of the user performing the user login action. Use `null` if the user is anonymous."
223    },
224    "anonymous_id": {
225      "type": "string",
226      "description": "Anonymous identifier assigned to the user if they are not logged in."
227    }
228  }
229}

Payload Example

1{
2  "context": {
3    "library": {
4      "name": "flick",
5      "version": "1.0.4"
6    },
7    "os": {
8      "name": "Mac OS",
9      "version": "10.15.7"
10    },
11    "timezone": "Asia/Calcutta",
12    "screen": {
13      "width": 1512,
14      "height": 859
15    },
16    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36",
17    "locale": "en-GB",
18    "device": {
19      "is_mobile": false
20    }
21  },
22  "event_id": "evt_1234567890",
23  "event_name": "user_login",
24  "version": "1",
25  "event_timestamp": "2025-01-31T12:34:56Z",
26  "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",
27  "event_type": "identity",
28  "phone": {
29    "phone": "8888888888",
30    "active": true,
31    "primary": true,
32    "verified": true,
33    "country_code": 1
34  },
35  "company_id": 123456,
36  "company_mode": "live",
37  "company_created_on": "2020-05-20T08:30:00Z",
38  "method": "password",
39  "login_value": "success",
40  "user_id": "user_12345"
41}

« remove_from_cart/engagement/v1

user_logout/identity/v1 »