Onboardingcompleted

Body

application/json

Fires when user has reached a final screen in your funnel. We currently consider a “final screen” as a screen with ID that starts with 'final'

string

required

Example:

"evt_00000000000000000000000000"

type

string

required

created_at

integer<int64>

required

UNIX timestamp in seconds

location

object

required

Show child attributes

location.funnel_id

string

required

location.funnel_version

integer

required

location.origin

string

required

location.query

string

required

location.query_params

object

required

Show child attributes

location.query_params.{key}

string

location.sandbox

boolean

required

location.onboarding

string

location.experiment_id

string

location.experiment_title

string

location.experiment_alias

string

profile

object

required

Show child attributes

profile.id

string

required

Example:

"pro_00000000000000000000000000"

profile.session_id

string

required

Example:

"ses_00000000000000000000000000"

profile.country

string

required

Example:

"GB"

profile.ip

string

required

Example:

"00.00.000.00"

profile.city

string

required

Example:

"Birmingham"

profile.time_zone

string

required

Example:

"Europe/London"

profile.user_agent

string

required

Example:

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

profile.locale

string

required

Locale name

Example:

"🇪🇸 Spanish"

profile.locale_code

string

required

Locale code

Example:

"en_US"

project_id

string

required

Example:

"00000000000000000000000000"

is_sandbox

boolean

required

Example:

false

session_id

string

required

Example:

"ses_00000000000000000000000000"

data

object

required

Show child attributes

data.id

string

required

data.ip

string

required

data.onboarding_version

integer

required

data.profile_id

string

required

data.query

string

required

data.query_params

object

required

Show child attributes

data.query_params.{key}

string

data.replies

object[]

required

Show child attributes

data.replies.screen

object

required

Show child attributes

data.replies.screen.id

string

required

data.replies.screen.index

integer

required

data.replies.screen.custom_id

string

data.replies.element

object

required

Show child attributes

data.replies.element.id

string

required

data.replies.element.type

string

required

data.replies.element.custom_id

string

data.replies.state

object

required

Show child attributes

data.replies.state.value

string

data.user_agent

string

required

data.city

string

data.country

string

data.fb_click_id

string

data.fb_pixel

string

data.amplitude_device_id

string

data.ga

string

data.origin

string

funnel_id

string

deprecated

Example:

"00000000000000000000000000"

profile_id

string

deprecated

Example:

"pro_00000000000000000000000000"

Response

200

Event received successfully

API reference

Webhook reference

Onboardingcompleted

Body

Response