Navigation Events

Events fired during screen navigation.

ScreenViewEvent

Fired when a screen is displayed to the user.


interface ScreenViewEvent extends BaseSDKEvent {
  type: 'screen_view';
  screen_id: string;
  screen_index: number;
  screen_name: string;
  is_first: boolean;
  is_last: boolean;
}

Field	Type	Description
`screen_id`	`string`	Unique screen identifier
`screen_index`	`number`	Screen position (0-indexed)
`screen_name`	`string`	Human-readable screen name
`is_first`	`boolean`	Is this the first screen
`is_last`	`boolean`	Is this the last screen


<BegynnOnboarding
  placementId="your-placement-id"
  onScreenView={(event) => {
    console.log("Viewing screen:", event.screen_name);
    console.log("Position:", event.screen_index + 1, "of total");
 
    if (event.is_last) {
      console.log("User reached the final screen");
    }
  }}
/>

ScreenLeaveEvent

Fired when the user leaves a screen.


interface ScreenLeaveEvent extends BaseSDKEvent {
  type: 'screen_leave';
  screen_id: string;
  screen_index: number;
  duration_ms: number;
}

Field	Type	Description
`screen_id`	`string`	Screen that was left
`screen_index`	`number`	Screen position (0-indexed)
`duration_ms`	`number`	Time spent on screen (milliseconds)


<BegynnOnboarding
  placementId="your-placement-id"
  onScreenLeave={(event) => {
    console.log("Left screen", event.screen_id);
    console.log("Time spent:", event.duration_ms, "ms");
  }}
/>

NavigationBackEvent

Fired when the user navigates back to a previous screen.


interface NavigationBackEvent extends BaseSDKEvent {
  type: 'navigation_back';
  from_screen_id: string;
  to_screen_id: string;
}

Field	Type	Description
`from_screen_id`	`string`	Screen navigating from
`to_screen_id`	`string`	Screen navigating to


<BegynnOnboarding
  placementId="your-placement-id"
  onNavigationBack={(event) => {
    console.log("Navigated back from", event.from_screen_id, "to", event.to_screen_id);
  }}
/>