{
"id": "evt_00000000000000000000000000",
"type": "onboarding.started",
"created_at": 123,
"location": {
"funnel_id": "<string>",
"funnel_version": 123,
"origin": "<string>",
"query": "<string>",
"query_params": {},
"sandbox": true,
"onboarding": "<string>",
"experiment_id": "<string>",
"experiment_title": "<string>",
"experiment_alias": "<string>"
},
"profile": {
"id": "pro_00000000000000000000000000",
"session_id": "ses_00000000000000000000000000",
"email": "me@example.com",
"country": "GB",
"ip": "00.00.000.00",
"city": "Birmingham",
"region_code": "FL",
"postal_code": "33028",
"time_zone": "Europe/London",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)",
"locale": "๐ช๐ธ Spanish",
"locale_code": "en_US"
},
"project_id": "00000000000000000000000000",
"is_sandbox": false,
"session_id": "ses_00000000000000000000000000",
"data": {
"id": "<string>",
"ip": "<string>",
"onboarding_version": 123,
"profile_id": "<string>",
"query": "<string>",
"query_params": {},
"replies": [
{
"screen": {
"id": "<string>",
"index": 123,
"custom_id": "<string>"
},
"element": {
"id": "<string>",
"type": "<string>",
"custom_id": "<string>"
},
"state": {
"value": "<string>"
}
}
],
"user_agent": "<string>",
"city": "<string>",
"country": "<string>",
"fb_click_id": "<string>",
"fb_pixel": "<string>",
"amplitude_device_id": "<string>",
"ga": "<string>",
"origin": "<string>"
},
"funnel_id": "00000000000000000000000000",
"profile_id": "pro_00000000000000000000000000"
}Webhook reference
Onboardingcompleted
WEBHOOK
onboarding.completed
{
"id": "evt_00000000000000000000000000",
"type": "onboarding.started",
"created_at": 123,
"location": {
"funnel_id": "<string>",
"funnel_version": 123,
"origin": "<string>",
"query": "<string>",
"query_params": {},
"sandbox": true,
"onboarding": "<string>",
"experiment_id": "<string>",
"experiment_title": "<string>",
"experiment_alias": "<string>"
},
"profile": {
"id": "pro_00000000000000000000000000",
"session_id": "ses_00000000000000000000000000",
"email": "me@example.com",
"country": "GB",
"ip": "00.00.000.00",
"city": "Birmingham",
"region_code": "FL",
"postal_code": "33028",
"time_zone": "Europe/London",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)",
"locale": "๐ช๐ธ Spanish",
"locale_code": "en_US"
},
"project_id": "00000000000000000000000000",
"is_sandbox": false,
"session_id": "ses_00000000000000000000000000",
"data": {
"id": "<string>",
"ip": "<string>",
"onboarding_version": 123,
"profile_id": "<string>",
"query": "<string>",
"query_params": {},
"replies": [
{
"screen": {
"id": "<string>",
"index": 123,
"custom_id": "<string>"
},
"element": {
"id": "<string>",
"type": "<string>",
"custom_id": "<string>"
},
"state": {
"value": "<string>"
}
}
],
"user_agent": "<string>",
"city": "<string>",
"country": "<string>",
"fb_click_id": "<string>",
"fb_pixel": "<string>",
"amplitude_device_id": "<string>",
"ga": "<string>",
"origin": "<string>"
},
"funnel_id": "00000000000000000000000000",
"profile_id": "pro_00000000000000000000000000"
}Body
application/json
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.
Example:
"evt_00000000000000000000000000"
Examples:
"onboarding.started"
"onboarding.completed"
"purchase.completed"
"profile.updated"
"subscription.activated"
"subscription.cancelled"
"subscription.renewed"
UNIX timestamp in seconds
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"00000000000000000000000000"
Example:
false
Example:
"ses_00000000000000000000000000"
Show child attributes
Show child attributes
Example:
"00000000000000000000000000"
Example:
"pro_00000000000000000000000000"
Response
200
Event received successfully
Was this page helpful?
