SSO Login Flow

PARAMETERS	Description	DATATYPE
clientId	The unique clientId is found on the dashboard.	string	REQUIRED
eventType		string	REQUIRED
eventLocation		string	REQUIRED
anonId	A unique anonymous ID for each user.	uuid	REQUIRED
url		string	OPTIONAL
isCookieBlocked		boolean	OPTIONAL
contentId	A unique id of each content.	string	REQUIRED
clickAction		string	REQUIRED
validationType		string	REQUIRED
firstTimeLogin		boolean	REQUIRED
userAgent		string	REQUIRED

User SignUp View Event

Description

It is an event that is triggered when the user views the sign-up/ login page for the first time.

Example:

{
"eventType": "VIEW",
"eventLocation": "SSO_SIGNUP",
"clientId": "5f92a62013332e0f667794dc",
"anonId": "b79064d2-2256-4c36-ad06-8c38cc0396c7",
"url": "http://localhost:9000/test.html",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"isCookieBlocked": 0,
"contentId":'contentId-1'
}

User Login View Event

Description

It is an event that is triggered when the user views the login page.

Example

{
"eventType": "VIEW",
"eventLocation": "SSO_LOGIN",
"clientId": "5f92a62013332e0f667794dc",
"anonId": "b79064d2-2256-4c36-ad06-8c38cc0396c7",
"url": "http://localhost:9000/test.html",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"isCookieBlocked": 0,
"contentId": 'article-20',
}

User OTP View Event

Description

It is an event that is triggered when the user views the OTP Page.

Example

{
"eventType": "VIEW",
"eventLocation": "SSO_LOGIN_OTP",
"clientId": "5f92a62013332e0f667794dc",
"anonId": "b79064d2-2256-4c36-ad06-8c38cc0396c7",
"url": "http://localhost:9000/test.html",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"isCookieBlocked": 0,
"contentId": 'article-20',
}

Note: This event is only needed to be sent when the Login is based on OTP.

User Click Event

Description

It is an event that is triggered when the user performs the click action when he/she logs in.

Example

{
"eventType": "CLICK",
"eventLocation": "SSO_LOGIN",
"clickAction": 'EMAIL' | 'MOBILE' | 'GOOGLE'
"clientId": "5f92a62013332e0f667794dc",
"anonId": "b79064d2-2256-4c36-ad06-8c38cc0396c7",
"url": "http://localhost:9000/test.html",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"isCookieBlocked": 0,
"contentId": 'article-20',
}

User Registration Event

Description

It is an event that is triggered when the user registers to your platform for the first time.

Example

{
"eventType": "REGISTRATION",
"eventLocation": "SSO_LOGIN",
"clientId": "5f92a62013332e0f667794dc",
"anonId": "b79064d2-2256-4c36-ad06-8c38cc0396c7",
"url": "http://localhost:9000/test.html",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"isCookieBlocked": 0
"userId": "5f92a62013332e0f667794dc",
"validationType": "OTP",
"firstTimeLogin": 1,
"contentId": 'article-20',
}

User Validation Event

Description

It is an event that is triggered when the user is validated whenever he logs in.

Example

{
"eventType": "VALIDATION",
"eventLocation": "SSO_LOGIN",
"clientId": "5f92a62013332e0f667794dc",
"anonId": "b79064d2-2256-4c36-ad06-8c38cc0396c7",
"url": "http://localhost:9000/test.html",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"isCookieBlocked": 0
"userId": "5f92a62013332e0f667794dc",
"validationType": "OTP",
"firstTimeLogin": 1,
"contentId": 'article-20',
}