v8

OpenAPI 3.1.02026-08-033623795.0 MB

Events

Create Event

Tracks a conversion or engagement event for an account.

post/events

Headers

Idempotency-Keystring

Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring required

The account to associate with this event.

The channel where an event originated

currency'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'eth' | 'ape' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'btc' | 'cny' | 'usdt' | 'kzt' | 'awg' | 'whop_usd' | 'xau' nullable

The available currencies on the platform

custom_namestring nullable

Custom event name when event_name is 'custom'. Maximum 35 chars for this value.

durationinteger nullable

For 'leave' events: milliseconds the visitor spent on the page.

event_idstring nullable

Client-provided identifier for deduplication. Generated if omitted.

event_namestring required

The type of event.

Use a standard event (lead, submit_application, contact, complete_registration, schedule, view_content, add_to_cart) or pass your own name directly for a custom event.

event_timestring date-time nullable

When the event occurred. Defaults to now.

plan_idstring nullable

The plan associated with the event.

product_idstring nullable

The product associated with the event.

referrer_urlstring nullable

The referring URL.

resumedboolean nullable

For 'page' events: true when the page was restored from the back/forward cache.

sourcestring nullable

For 'identify' events: where the identity was captured (url, form, manual, iframe).

titlestring nullable

For 'page' events: the document title.

urlstring nullable

The URL where the event occurred.

valuenumber nullable

Monetary value associated with the event.

Example request

{
  "context": {
    "fingerprint_confidence": 6.9
  },
  "duration": 42,
  "event_id": "evnt_xxxxxxxxxxxxx",
  "event_name": "course_completed",
  "event_time": "2023-12-01T05:00:00.401Z",
  "plan_id": "plan_xxxxxxxxxxxxx",
  "product_id": "prod_xxxxxxxxxxxxx",
  "user": {
    "birthdate": "1990-01-15",
    "member_id": "mber_xxxxxxxxxxxxx",
    "membership_id": "mem_xxxxxxxxxxxxxx",
    "user_id": "user_xxxxxxxxxxxxx"
  },
  "value": 6.9
}

Response

event created

idstring required