Events Overview

The SDK communicates events via WebView postMessage. Events are dispatched to their respective handlers as users interact with the onboarding.

Event Handlers

Handler	Event Type	Description
`onReady`	`ReadyEvent`	Onboarding loaded
`onStart`	`OnboardingStartEvent`	User started
`onComplete`	`OnboardingCompleteEvent`	User completed
`onExit`	`OnboardingExitEvent`	User exited early
`onScreenView`	`ScreenViewEvent`	Screen displayed
`onScreenLeave`	`ScreenLeaveEvent`	Left screen
`onNavigationBack`	`NavigationBackEvent`	Navigated back
`onButtonClick`	`ButtonClickEvent`	Button clicked
`onChoiceSelect`	`ChoiceSelectEvent`	Choice selected
`onChoiceDeselect`	`ChoiceDeselectEvent`	Choice deselected

Generic Handlers

onEvent

Catch-all handler that receives every event:


<BegynnOnboarding
  placementId="your-placement-id"
  onEvent={(event) => {
    console.log("Event:", event.type, event);
  }}
/>

onError

Error handler for SDK errors:


<BegynnOnboarding
  placementId="your-placement-id"
  onError={(error) => {
    console.error("Onboarding error:", error);
  }}
/>

Base Event Fields

All events extend BaseSDKEvent and include these fields:

Field	Type	Description
`type`	`SDKEventType`	Event type identifier
`timestamp`	`string`	ISO 8601 timestamp
`onboarding_id`	`string`	Onboarding flow ID
`session_id`	`string`	Current session ID
`uid`	`string`	Persistent user ID
`placement_id`	`string`	Placement ID


interface BaseSDKEvent {
  type: SDKEventType;
  timestamp: string;
  onboarding_id: string;
  session_id: string;
  uid: string;
  placement_id: string;
}