Options
All
  • Public
  • Public/Protected
  • All
Menu

Fires each time a Getting Started checklist item is auto-ticked (step completed). Records which step finished and how far the partner has progressed. Onboarding is tracked per-user, not per-gallery.

example
{
  action: "progressedOnboarding",
  completed_step_count: 3,
  context_module: "onboardingFlow",
  context_page_owner_type: "inventory",
  step: "create an artwork",
  total_steps: 10
}

Hierarchy

  • ProgressedGettingStarted

Index

Properties

action

action: progressedOnboarding

completed_step_count

completed_step_count: number

context_module

context_module: onboardingFlow

context_page_owner_type

context_page_owner_type: collection | inventory

step

step: string

Lower-case label matching UI copy (e.g. "create an artwork"). Typed as string because steps are backend-defined and expected to evolve.

total_steps

total_steps: number

Generated using TypeDoc