Login Event

Description

The Login Event should be fired when a user logs in to the client’s platform. This event applies to all verticals and captures essential user authentication and engagement details.

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 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_skinId": "skin123",
        "ootb_license": "licenseXYZ"
    }
}

Parameters

Parameter Key	Parameter Name	Data Type	Description
`ootb_login_timestamp`	Login Timestamp	String	ISO 8601 datetime of the login.
`ootb_balance`	Balance	Number	The user’s balance at login.
`ootb_is_first_login`	Is First Login	Boolean	Indicates if this is the first login (`true` or `false`).
`ootb_session_ref`	Session Reference	String	Reference to the game session.
`ootb_ccy_code`	CCY Code	String	The currency code (e.g., USD).
`ootb_language`	Language	String	The language preference (e.g., en).
`ootb_country`	Country	String	The country code (e.g., US).
`ootb_platform`	Platform	String	The platform used (e.g., iOS, Android).
`ootb_channel`	Channel	String	The channel used for the login (e.g., mobile, web).
`ootb_skinId`	Skin ID	String	The skin ID.
`ootb_license`	License	String	The license string.

Notes

Mandatory Properties

The following properties are mandatory for all events and should be included in every event payload. See the Mandatory Properties page for detailed explanations:

tenant (Number): The identifier for the tenant.
timestamp (String): The time the event was recorded in UTC (format: YYYY-MM-DD HH:MM:SS.ssssss UTC).
event (String): The event name, e.g., ootb_login.
customer (String): The identifier for the customer.

Context Parameters

These properties provide additional details specific to the Login Event. They are optional but highly recommended for enriched insights:

ootb_login_timestamp (String): ISO 8601 datetime of login (e.g., 2024-05-27T10:30:00Z).
ootb_balance (Number): The user’s balance.
ootb_is_first_login (Boolean): Indicates if this is the first login (true or false).
ootb_session_ref (String): Reference to the game session.
ootb_ccy_code (String): The currency code (e.g., USD).
ootb_language (String): The language preference (e.g., en).
ootb_country (String): The country code (e.g., US).
ootb_platform (String): The platform used (e.g., iOS, Android).
ootb_channel (String): The channel used for login (e.g., mobile, web).
ootb_skinId (String): The skin ID.
ootb_license (String): The license string.