Interface OnboardingConfig

Configuration for onboarding flow

interface OnboardingConfig {
    authCode?: string;
    containerId: string;
    enforceOnboarding?: boolean;
    entryPoint?: "contacts";
    organizationDetails?: OrganizationDetails;
    userDetails?: UserDetails;
}

Hierarchy (view full)

BaseFlowConfig
- OnboardingConfig

Index

Properties

authCode? containerId enforceOnboarding? entryPoint? organizationDetails? userDetails?

Properties

`Optional`authCode

authCode?: string

Optional authorization code for the flow

containerId

containerId: string

The ID of the DOM element to inject the flow iframe into

`Optional`enforceOnboarding

enforceOnboarding?: boolean

`Optional`entryPoint

entryPoint

Optional entry point context — affects the externalOrigin passed to the platform

`Optional`organizationDetails

organizationDetails?: OrganizationDetails

`Optional`userDetails

userDetails?: UserDetails