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",
    "country": "GB",
    "ip": "00.00.000.00",
    "city": "Birmingham",
    "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"
  },
  "funnel_id": "00000000000000000000000000",
  "profile_id": "pro_00000000000000000000000000",
  "project_id": "00000000000000000000000000",
  "is_sandbox": false,
  "session_id": "ses_00000000000000000000000000",
  "data": {
    "id": "<string>",
    "city": "<string>",
    "country": "<string>",
    "fb_click_id": "<string>",
    "fb_pixel": "<string>",
    "amplitude_device_id": "<string>",
    "ga": "<string>",
    "ip": "<string>",
    "onboarding_version": 123,
    "origin": "<string>",
    "profile_id": "<string>",
    "query": "<string>",
    "query_params": {},
    "replies": [
      {
        "screen": {
          "custom_id": "<string>",
          "id": "<string>",
          "index": 123
        },
        "element": {
          "custom_id": "<string>",
          "id": "<string>",
          "type": "<string>"
        },
        "state": {
          "value": "<string>"
        }
      }
    ],
    "user_agent": "<string>"
  }
}

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'

The body is of type object.

Response

200

Event received successfully