Engage

webDeveloper

The ScaleBun.engage namespace — 5 members.

Updated August 12, 2026Reviewed August 7, 2026

TypeScript

import ScaleBun from '@scalebun/web';
ScaleBun.engage.<method>(…);

Members#

Member	Signature
`track`	`track(name: string, props?: Record<string, unknown>): void`
`refresh`	`refresh(): Promise<void>`
`submit`	`submit(surveyId: string, result: EngageSurveyResult): Promise<'success' \| 'error'>`
`emitRatingEvent`	`emitRatingEvent(type: EngageRatingEventType, input?: EngageRatingEventInput): void`
`resetInAppState`	`resetInAppState(): Promise<void>`

TypeScript

ScaleBun.engage.track(name: string, props?: Record<string, unknown>): void

Track a custom event that can trigger a survey (alias of track, kept for parity).

TypeScript

ScaleBun.engage.refresh(): Promise<void>

Re-fetch the active survey config (e.g. after login / a context change).

TypeScript

ScaleBun.engage.submit(surveyId: string, result: EngageSurveyResult): Promise<'success' | 'error'>

E2 — submit a response from a custom survey UI → 'success'|'error' (retried, idempotent).

TypeScript

ScaleBun.engage.emitRatingEvent(type: EngageRatingEventType, input?: EngageRatingEventInput): void

E2 — emit one rating-funnel event (eligible/shown/dismissed/selected/store_redirect).

TypeScript

ScaleBun.engage.resetInAppState(): Promise<void>

E2 — dev/QA: clear on-device engage state so campaigns show again (no incognito needed).