Skip to content

onboarding.completed

POST

Fires when the user reaches a final screen in your funnel. A final screen is currently defined as a screen with the screen type set to ‘Finish’ or with ID that starts with ‘final’. Fires once per session.

Media typeapplication/json
object
id
required
string

Example: evt_00000000000000000000000000

type
required
string
created_at
required

UNIX timestamp in seconds

integer format: int64
location
required
object
Show 10 propertiesHide properties
funnel_id
required
string
funnel_version
required
integer
origin
required
string
query
required
string
query_params
required
object
Show 1 propertyHide property
key
additional properties
string
sandbox
required
boolean
onboarding
string
experiment_id
string
experiment_title
string
experiment_alias
string
profile
required
object
Show 12 propertiesHide properties
id
required
string

Example: pro_00000000000000000000000000

session_id
required
string

Example: ses_00000000000000000000000000

email
required

User email address

string format: email

Example: me@example.com

country
required
string

Example: GB

ip
required
string

Example: 00.00.000.00

city
required
string

Example: Birmingham

region_code
required

Region or state code, null when geo data is unavailable

string
nullable

Example: FL

postal_code
required

Postal code, null when geo data is unavailable

string
nullable

Example: 33028

time_zone
required
string

Example: Europe/London

user_agent
required
string

Example: Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)

locale
required

Locale name

string

Example: 🇪🇸 Spanish

locale_code
required

Locale code

string

Example: en_US

funnel_id
string

Example: 00000000000000000000000000

profile_id
string

Example: pro_00000000000000000000000000

project_id
required
string

Example: 00000000000000000000000000

is_sandbox
required
boolean

Example: false

session_id
required
string

Example: ses_00000000000000000000000000

data
required
object
data
required
object
Show 15 propertiesHide properties
id
required
string
city
string
country
string
fb_click_id
string
fb_pixel
string
amplitude_device_id
string
ga
string
ip
required
string
onboarding_version
required
integer
origin
string
profile_id
required
string
query
required
string
query_params
required
object
Show 1 propertyHide property
key
additional properties
string
replies
required
Array<object>
Show 3 propertiesHide properties
screen
required
object
Show 3 propertiesHide properties
custom_id
string
id
required
string
index
required
integer
element
required
object
Show 3 propertiesHide properties
custom_id
string
id
required
string
type
required
string
state
required
object
Show 1 propertyHide property
value
string
user_agent
required
string

200 Event received successfully

Section titled “200”