Events describe actions yourcustomers perform or actions that result in an update to their customer record such as viewing your web page or visiting your store in New York.

Compose events

Events are composed using a two-tier connection including atype andaction. You can set additional metadata with fields on the event.

• The eventtype is a categorical name associated with the event.
• The eventaction is the activity a user did within that event type.

For example:

• order and product would be eventtypes
• purchase, return, or add_to_cart would beactions

At minimum, events require an event type and an identifier to associate the event with a customer. Theevent() method automatically passes the VUID (cookie ID) to ODP. You can include additional identifiers, like email or phone number which will associate that cookie ID with the other identifiers. Refer toOverview of customer identity and resolution to learn more.

🚧

Important

All ODP events are immutable, meaning you cannot change them after you upload them to ODP.

Standard events

A standard event is an event that has a predefined event type and action. Using standard events makes using ODP simpler for common use cases.

Reference and examples:

• ODP Web SDK
• ODP REST API
• ODP React Native SDK

Account event

Set the event type toaccount to track your users actions for login, logout, register and update.

Pageview event

Set the event type topageview to track which pages your user visits.

📘

Note

The Web SDK automatically populates thepage field when event type ispageview.

Wishlist

Set the event type toproduct to track a user adding or removing an item from a wishlist.

Navigation events

Set the event type tonavigation to track what your user's search.

Custom events

A custom event is where you create the event type and action and choose additional fields to use.

Custom events display on the customer profile (Customers > Profiles) in ODP.

📘

Note

See how toCreate custom fields. You must selectEvents from theObject Containing New Field drop-down list.

Example

Reference:

• ODP Web SDK
• ODP React Native SDK

Active events

❗️

Warning

Use this only for the rare case where you have an event that is not triggered by a customer. Abuse of this functionality may result in a loss of data.

An active event is helpful for events like campaign sends, subscription and support ticket events generated by an agent where the customer was not the direct source of the event.

This field lets ODP determine if an event was active or not. If it is set totrue, then that is considered customer activity. This means thatthe event will impact the calculation of Monthly Active Users (MAUs). It also may exclude reporting from certain engagements, like Customer Lifecycle, when appropriate.

Automatic active events

🚧

Caution

If the field is left blank, the default value istrue, meaning it is assumed that the event is active.

Some events are set toinactive by default (active_event =false).

📘

Note

If needed, a developer can override by including the field on the event payload.

Updated 25 days ago