Skip to main content
POST
/
api
/
v1
/
events
/
track
Track client-side event
curl --request POST \
  --url https://api.example.com/api/v1/events/track \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "onboarding.started",
  "metadata": {}
}
'
{
  "success": true
}

Body

application/json
​
event
enum<string>
required
Available options:
onboarding.started,
onboarding.step_1_welcome,
onboarding.step_2_setup_workspace,
onboarding.step_3_verify_nodejs,
onboarding.step_4_create_token,
onboarding.step_5_export_token,
onboarding.step_6_install_sdk,
onboarding.step_7_create_script,
onboarding.step_8_run_script,
onboarding.completed,
onboarding.skipped
​
metadata
object

Response

Event tracked successfully

​
success
boolean
required