Mandatory Properties for Standard Events

All Standard events require the following properties. These fields ensure consistency across events and allow the platform to process and attribute events correctly. They must be included in every event payload.

Mandatory Properties

Property	Type	Description	Example
`tenant`	Number	The unique identifier for the tenant sending the event.	`567`
`timestamp`	String	The UTC timestamp when the event occurred. Must follow the format `YYYY-MM-DD HH:MM:SS.ssssss UTC`.	`2024-05-27 10:30:00.000000 UTC`
`event`	String	The event name. This specifies the action or type of event (e.g., "login", "purchase").	`ootb_login`
`visitor`	String	The visitor ID as issued from Optimove SDK. Either this or `customer` are mandatory, and events that do not contain one of these will be rejected.	`visitorId1`
`customer`	String	The unique persistent identifier of the customer associated with the event. This will be used for matching these events with other data points in Optimove system. Either this or `visitor` are mandatory, and events that do not contain one of these will be rejected.	`customerId1`

Detailed Explanations

1. `tenant`

Purpose: Identifies the tenant sending the event.
Constraints: Must be a valid numeric identifier.
Example: 567

2. `timestamp`

Purpose: Indicates when the event occurred in UTC.
Format: YYYY-MM-DD HH:MM:SS.ssssss UTC.
Notes: This timestamp is crucial for chronological ordering and time-based reporting.
Example: 2024-05-27 10:30:00.000000 UTC

3. `event`

Purpose: Specifies the unique identifier for the event type.
Example: ootb_login

4. `customer`

Purpose: Links the event to a specific customer in your system.
Notes: This ID must match the customer's identifier in your database.
Example: customerId1

Example JSON Payload

Here’s an example of how the mandatory properties fit within an event:

{
    "tenant": 567,
    "timestamp": "2024-05-27 10:30:00.000000 UTC",
    "event": "ootb_login",
    "customer": "customerId1"
}

Why These Properties Are Important

Standardization: Ensures consistent structure across all events.
Attribution: Associates events with the correct tenant and customer.
Reporting: Facilitates accurate reporting and analysis of event data.
Processing: Enables the platform to process events properly.

Mandatory Properties

Detailed Explanations

1. tenant

2. timestamp