Standard Deposit

Event Key

ootb_deposit

This event should be sent when a user conducts a deposit.

Event Key	Event Name	Type
ootb_deposit	OOTB Deposit	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 Standard Deposit Event:

{
  "context": {
	"ootb_transaction_id":"11228836059",
        "ootb_deposit_timestamp": "2022-04-09T20:01:51.887000Z",
        "ootb_start_balance": 100.00,
        "ootb_deposit_amount": 50.00,
        "ootb_deposit_method": "credit_card",
        "ootb_deposit_status": "completed",
        "ootb_language": "en",
        "ootb_country": "US",
        "ootb_platform": "iOS",
        "ootb_channel": "mobile",
        "ootb_brand": "brand123",
        "ootb_license": "licenseXYZ"
    }
}

Parameters

📘
Events-based Integration (EBI): parameter classification
The Events-based Integration column shows how each parameter is treated when you onboard using an Events-based Integration:

Mandatory — required for the event to be ingested and processed correctly.

Mandatory if required for the execution channel integration — required only when the relevant execution channel (e.g., email, SMS, push, WhatsApp) is part of your integration.

Enrichment- used for out-of-the-box attribute — not required, but when provided it powers an Optimove out-of-the-box attribute.

Optional — accepted and stored when provided; not required and not tied to an OOTB attribute.

Parameter Key	Parameter Name	Type	Description	Events-based Integration
`ootb_transaction_id`	Transaction ID	String/Number	Unique identifier for the transaction that resulted in the balance update.	Mandatory
`ootb_deposit_timestamp`	Deposit Timestamp	String	ISO 8601 datetime of the deposit.	Mandatory
`ootb_start_balance`	Start Balance	Number	The user’s balance before the deposit.	Optional
`ootb_deposit_amount`	Deposit Amount	Number	The amount of the deposit.	Enrichment- used for out-of-the-box attribute
`ootb_deposit_method`	Deposit Method	String	The method used for the deposit (e.g., credit_card).	Optional
`ootb_deposit_status`	Deposit Status	String	The status of the deposit (e.g., completed).	Mandatory
`ootb_language`	Language	String	The language preference (e.g., en).	Optional
`ootb_country`	Country	String	The country code (e.g., US).	Optional
`ootb_platform`	Platform	String	The platform used (e.g., iOS, Android).	Enrichment- used for out-of-the-box attribute
`ootb_channel`	Channel	String	The channel used for the deposit (e.g., mobile, web).	Optional
`ootb_brand`	Brand	String	The brand associated with the deposit.	Optional
`ootb_license`	License	String	The license string associated with the deposit.	Optional