Events

🚧
The v3 API is deprecated
The v3 API is deprecated and will be sunset on December 31, 2027. Please follow the migration guide to move to the latest stable Omnisend API version.

Endpoint: https://api.omnisend.com/v3/events

Custom events

Custom events are used to trigger custom automation workflows through API. All custom events can have custom fields for any type of additional information, that should be used in the content of those automated emails.

Custom fields

fields is an object with keys and values with predefined corresponding types. Custom fields can contain any information needed in automated emails.

Custom fields support the following types:

int - integer
float - float
bool - boolean
string - strings
email - string, email format
url - string, url format
date - format: YYYY-MM-DD
dateTime - ISO 8601 format. Example: 2017-05-30T14:11:12Z