Search docs
Find a page, section or endpoint

Send events

Event format

The event envelope: required fields, exact spellings, properties and timestamps.

An event is one JSON object describing one thing that happened. Browser and server events use the same format.

Example#

purchase event 
{
  "envelop_version": "1.0",
  "id": "0b6bd7e7-1a4b-4d12-8fd3-9f8f0f2a1b2c",
  "name": "purchase",
  "tenant_id": "breeze",
  "workspace_id": "my-store",
  "anon_id": "cookie:3f9a1c7e",
  "occured_at": "2026-10-08T10:15:00Z",
  "properties": {
    "order_id": "ORD-10421",
    "amount": 2499,
    "currency": "INR",
    "identifiers": {
      "email": "[email protected]",
      "phone": "+919812345678",
      "cookie": "3f9a1c7e"
    }
  }
}

Fields#

envelop_version string Required
Always "1.0". The spelling (one "e") is part of the format.
id string (UUID) Required
Unique event id. Resending the same id is safe: it is processed once.
name string Required
Event type, lowercase, and registered beforehand, such as purchase, initiatecheckout or addshippinginfo.
tenant_id string Required
Your tenant. Matches the x-tenant-id header.
workspace_id string
Your workspace id or one of its aliases, such as a shop domain. Always send it: when it's missing, the event goes to a workspace named default.
anon_id string Required
A stable id for the sender, usually the browser cookie. In the typed form "cookie:<value>" it also counts as an identifier when properties.identifiers is absent.
actor_id string
Typed identifier of a known user, such as "email:[email protected]". Only used when properties.identifiers is absent.
occured_at RFC 3339 time Required
When it happened, in UTC, such as 2026-10-08T10:15:00Z. Spelled with one "r". Metrics and "last seen" times use this, not the arrival time.
properties object
Anything about the event: amount, order id, product id, country. Metrics read values from here by path.
properties.identifiers object
Who this is: a map of identifier type to value(s). See Identifiers. It is removed from the stored properties.

Next#

Identifiers

Tell BreezeIQ who each event belongs to.
From your server

Send trusted events with email and phone.
From the browser

Send anonymous events from your storefront.