Login Event

This document describes the Out-Of-The-Box (OOTB) Login event schema. A login event should be fired when a user successfully logs into the client's platform. This event is relevant for ALL client verticals.

Event Key

Event Key	Event Name	Type
`ootb_login`	OOTB Login	Simple event

Event Structure

The mandatory properties (tenant, timestamp, event, and customer) are required for all events and documented in detail on the Mandatory Properties page.

Below is the JSON structure for the context-specific properties of the OOTB Login event.

{
  "context": {
    "ootb_login_timestamp": "2024-05-27T10:30:00Z",
    "ootb_balance": 100.50,
    "ootb_is_first_login": false,
    "ootb_session_ref": "session12345",
    "ootb_ccy_code": "USD",
    "ootb_language": "en",
    "ootb_country": "US",
    "ootb_platform": "iOS",
    "ootb_channel": "mobile",
    "ootb_skin_id": "skin123",
    "ootb_license": "licenseXYZ"
  }
}

Parameters

Optional fields are marked with an asterisk (*).

Parameter Key	Parameter Name	Type	Description
`ootb_login_timestamp`*	OOTB Login Timestamp	String	ISO 8601 datetime of the login event.
`ootb_balance`*	OOTB Balance	Number	The user's account balance at the time of login.
`ootb_is_first_login`*	OOTB Is First Login	Boolean	Indicates if this is the user's first login (`true` or `false`).
`ootb_session_ref`*	OOTB Session Reference	String	Reference to the game or user session.
`ootb_ccy_code`*	OOTB CCY Code	String	The currency code associated with the user's account (e.g., `USD`).
`ootb_language`*	OOTB Language	String	The language preference of the user (e.g., `en`).
`ootb_country`*	OOTB Country	String	The country code of the user (e.g., `US`).
`ootb_platform`*	OOTB Platform	String	The platform used for the login (e.g., `iOS`, `Android`, `Web`).
`ootb_channel`*	OOTB Channel	String	The channel used for the login (e.g., `mobile`, `web`, `app`).
`ootb_skin_id`*	OOTB Skin ID	String	Identifier for the specific skin or brand of the platform being accessed.
`ootb_license`*	OOTB License	String	The license string or identifier relevant to the user's session/region.

Explanation

event: Set to ootb_login to signify a user has successfully logged in.
context:
- ootb_login_timestamp: The exact date and time the login occurred.
- ootb_balance: The user's available balance upon logging in.
- ootb_is_first_login: A boolean flag indicating if this is the very first time the user has logged in.
- ootb_session_ref: An identifier for the user's current session.
- ootb_ccy_code: The currency applicable to the user's account.
- ootb_language: The language setting for the user's session.
- ootb_country: The country associated with the user or login attempt.
- ootb_platform: The technical platform (e.g., operating system, device type) used for login.
- ootb_channel: The broader channel through which the login occurred (e.g., mobile app vs. website).
- ootb_skin_id: If applicable, identifies the specific brand or interface skin the user logged into.
- ootb_license: Relevant regulatory or operational license identifier.