HomeGuidesAPI ReferenceGraphQL
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Events

This topic describes events in Optimizely Data Platform (ODP).

Events are any action your customers perform or actions that result in an update to their customer record. For example, viewing your web page or visiting your store in New York.

Every Event is classified by a type (for example, order, product or email) and action (for example, purchase, view or open) and additional metadata stored in Fields (for example, product_id).

Default Events

Account events

How to set up a custom event for login, logout, register and updates.

typeaction
accountlogin
accountlogout
accountregister
accountupdate

Page view events

typepage
pageview/products/12345

πŸ“˜

Note

The Web SDK will automatically populate the page field when event type is pageview.

Navigation events

typeactionsearch_term
navigationsearchcameras
navigationsort
navigationfilter

Custom events

Custom events are events for which you create the event type/action and choose which fields to use and/or create.

Custom events display on the customer profile (Customers > Profiles). The Custom Events API also displays the metadata associated with the event in the profile.

πŸ“˜

Note

Go to Account Settings > Objects & Fields to create custom events in ODP. See Create custom fields for more information on creating custom events.

You must select Events from the Object Containing New Field drop-down list.

Example

typeactionvenue_name
venuevisitedTD Garden

Reference

To begin sending events to ODP, refer to the specific documentation for your platform:

API Reference

Web SDK

Active events

❗️

Warning

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

This 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 allows ODP to determine if an event was active or not. If it is set to true, then that is considered customer activity.

This means that the event will impact our calculation of Monthly Active Users (MAUs), it also allows us to exclude from certain engagement reporting like Customer Lifecycle when appropriate.

Automatic active events

🚧

Caution

If the field is left blank, we will set the value to true by default, meaning it is assumed that the event is active.

Field Display Name

Field Name

Field Type

Field Description

Is Active Event?

active_event

True / False boolean

Indicates whether this event should contribute to Monthly Active User (MAU) calculations. Is false if the event is not triggered directly by the customer.
Examples include campaign sends and support tickets being closed. If not set, will be set to β€œtrue”, making the event active.

typeaction
customer_discovered
campaign
consent
reachability
list
emailany action not open or click
pushany action not open or click

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

πŸ“˜

Note

If needed, this can be overridden by a developer by including the field on the event payload.


Did this page help you?