Standard User Event

Required data to get started with Opti-X

A real-time feed of data describing customer activity. Some events may need to be sourced from multiple systems. The events should include customer account and banking activity such as registrations, logins, deposits, and withdrawals.

The data tables and fields described in this document represent an ideal data structure for using Opti-X. If your data does not include everything presented here, alternative methods exist based on the available data.


Page Visit (Mandatory event)

Recording when a user views a specific page on a platform or website.

This is a basic event set in Optimove's platform, and has mandatory parameters.

Event setup:

Event KeyEvent NameType
set_page_visitPage VisitSimple event

Event's Parameters:

Parameter KeyParameter NameTypeDescription
customURLCustom URLStringMandatory
pageTitlePage TitlestringMandatory
categoryPage CategorystringNOT Mandatory



Registration

Capturing the process of users creating new accounts on a platform or service.

Event setup:

Event KeyEvent NameType
core_registrationCore RegistrationSimple event

Recommended parameters for registration event:

Parameter KeyParameter NameTypeDescription
emailEmailStringMandatory in case you want to send an email after registration
first_nameFirst NamestringIt can be used for personalization tags



Login

Tracking instances when users log into their accounts on a platform.

Event setup:

Event KeyEvent NameType
core_loginCore LoginSimple event

Recommended parameters for Login event:

Parameter KeyParameter NameTypeDescription
login_timestampLogin timestampStringISO 8601 datetime of login
balanceBalanceNumber
is_first_loginIs First LoginBooleanIs the first time they have logged in?
session_refGame Session ReferenceString
ccy_codeCCY CodeString
languageLanguageString
countryCountryString
platformPlatformString
channelChannelString
skinIdSkin IDString
licenseLicenseString



Deposit

Recording when a user makes a deposit attempt in their account.

Event setup:

Event KeyEvent NameType
core_depositCore DepositSimple event

Recommended parameters for deposit event:

Parameter KeyParameter NameTypeDescription
deposit_timestampDeposit timestampStringISO 8601 datetime of deposit
start_balanceStart BalanceNumber
deposit_amountDeposit AmountNumber
deposit_methodDeposit MethodString
deposit_statusDeposit StatusString
ccy_codeCCY CodeString
languageLanguageString
countryCountryString
platformPlatformString
channelChannelString
skinIdSkin IDString
licenseLicenseString



Withdrawal

Recording when a user withdraws funds or removes money from their account.

Event setup:

Event KeyEvent NameType
core_withdrawalCore WithdrawalSimple event

Recommended parameters for withdrawal event:

Parameter KeyParameter NameTypeDescription
withdrawal_timestampWithdrawal request timestampStringISO 8601 datetime of withdrawal
start_balanceStart BalanceNumber
withdrawal_amountWithdrawal AmountNumber
withdrawal_methodWithdrawal MethodString
withdrawal_statusWithdrawal StatusStringOptional
ccy_codeCCY CodeString
languageLanguageString
countryCountryString
platformPlatformString
channelChannelString
skinIdSkin IDString
licenseLicenseString



Withdrawal Cancellation

Capturing instances where a withdrawal process is initiated but cancelled before completion.

Event setup:

Event KeyEvent NameType
core_withdrawal_cancellationCore Withdrawal CancellationSimple event

Recommended parameters for withdrawal cancellation event:

Parameter KeyParameter NameTypeDescription
event_nameEvent nameStringcore_withdrawal_cancellation
withdrawal_cancel_timestampWithdrawal cancellation timestampStringISO 8601 datetime of withdrawal cancellation
end_balanceEnd BalanceNumberBalance after cancellation
withdrawal_amountWithdrawal AmountNumber
withdrawal_methodWithdrawal MethodString
withdrawal_statusWithdrawal StatusStringOptional
ccy_codeCCY CodeString
languageLanguageString
countryCountryString
platformPlatformString
channelChannelString
skinIdSkin IDString
licenseLicenseString