POST

Overview

The onboarding.started event is triggered when a user reaches the final screen in your onboarding. A 'final screen' is defined as any screen with an ID that begins with 'final'."

Payload

Parameter Type Example
id required string evt_00000000000000000000000000
type required string onboarding.completed
created_at
required int64, UNIX timestamp in seconds 1716672462
location required ILocation
profile required IProfile
project_id required string 00000000000000000000000000
is_sandbox required boolean true
session_id required string ses_00000000000000000000000000
data required IData

ILocation

Parameter Type
funnel_id required string
funnel_version required integer
origin required string
query_params required object
sandbox required boolean
onboarding optional string

IProfile

Parameter Type Example
id required string pro_00000000000000000000000000
session_id required string ses_00000000000000000000000000
country required string GB
ip required string 00.00.000.00
city required string Birmingham
time_zone required string Europe/London
user_agent required string Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)
locale required string 🇪🇸 Spanish

IData

Parameter Type
id required string
ip required string
city optional string
country optional string
amplitude_device_id optional string
ga optional string
onboarding_version required string
origin optional string
profile_id required string
query required string
query_params required object
replies required array of objects, [IReply](<https://adapty.notion.site/061aa0ab26924a139e39a562553811df>)[]
user_agent required string

IReply

Parameter Type
screen required IScreen
element required IElement
state required IState

IScreen

Parameter Type
custom_id optional string
id required string
index required integer

IElement

Parameter Type
custom_id required string
id required string
type required string

IState

Parameter Type
value required string