Introduction
There are two types of events you can send to Omnisend:
- recommended events are predefined with specific names and properties, designed to help you take advantage of Omnisend's pre-built automation presets, reporting capabilities, and segment templates. These events cover key e-commerce actions, such as "added product to cart," "started checkout," "placed order," and similar activities.
- custom events are user-defined events that you create and implement according to your specific needs. Unlike recommended events, they do not have predefined names or properties and do not come with pre-built automation or segment templates. However, they offer flexibility for creating custom rules in segmentation, setting triggers and filters in automation, and are displayed in contact profiles for tailored tracking and analysis.
Also, there are two ways how events can be passed to Omnisend:
- JavaScript API for real-time events triggered directly from your website.
- REST API for server-side events triggered by backend processes.
Note: To enable JavaScript API in your website, please refer to the JavaScript Snippet Documentation.
Recommended Events
At the moment we are providing the following recommended events:
- added product to cart
- started checkout
- placed order
- paid for order
- ordered product
- order refunded
- order fulfilled
- order canceled
- viewed product
To start benefiting from recommended events and address specific cases, please take a look at the following guides:
- How to: track cart events
- How to: enable product abandonment
- How to: enable cart/checkout abandonment
- How to: send events using Events API
- How to: enable order confirmation
- How to: send custom events to trigger custom automations
Each recommended customer event is associated with a specific version and origin. To ensure data is sent accurately, consult the guide or specific event documentation for the correct origin and version details.
Custom Events
For situations where additional events are needed beyond the recommended ones, you can send custom events. For detailed instructions refer to the How to: send custom events to trigger custom automations guide.
Version and origin explained
These are essential event properties that must be configured correctly. Incorrect versions and origins can result in data inconsistencies and cause issues with Omnisend automations, segmentation, and reporting.
Version
- versions for recommended events are predefined and must be followed. Please refer to each event definition.
- custom events doesn't have versions, and can be omitted in the payload.
Origin
Origin defines the source of the event.
- if you are integrating a custom store, set the origin to 'api`.
- if you are 3rd party developer building an app, you should set the origin to app name.
- if you are an e-commerce platform building an integration, contact us for guidance.
Event deduplication
To avoid processing duplicate events, use eventID property. If it is not provided, we will create a new one each time the event is sent.