Skip to main content
POST
Track an event

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Body

application/json
userId
string
required

The user's external ID — the same value passed to usertour.identify(). Unseen users are created.

Required string length: 1 - 200
name
string
required

The event code name. An unknown name creates the event definition on first use; built-in Usertour event names are refused.

Required string length: 2 - 100
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
companyId
string

External ID of the company to associate the event with. Must already exist — an unknown id records the event without the association.

Required string length: 1 - 200
attributes
object

Event attribute values. Unknown attribute names register on the event definition automatically.

occurredAt
string<date-time>

When the event actually happened (ISO 8601); defaults to now.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

The recorded event

id
string
required
object
enum<string>
required
Available options:
event
codeName
string
required
eventDefinitionId
string
required
createdAt
string
required
userId
string
required
companyId
string | null
required
sessionId
string | null
required
contentId
string | null
required
versionId
string | null
required
attributes
object
required