Flutter SDK

Flutter API reference

Find the public Flutter facade, configuration, identity, messaging, knowledge base, telemetry, flag, theme, and push types.

Btx facade

Start new integrations with the static Btx facade and BtxHost.

Btx.configure(...) creates or replaces the SDK runtime configuration.
Btx.identify(...) binds a customer or clears identity with null.
Btx.ready() waits for pending configure and identity work.
Btx.log(...) queues structured telemetry.
Btx.featureFlags, isFeatureEnabled(...), featureFlagEnabled(...), and refreshFeatureFlags() expose evaluated flags.
Btx.messenger, Btx.knowledgeBase, and Btx.push group customer-facing actions.
Btx.status and statusListenable expose active, inactive, disabled, and disposed telemetry state.
Btx.flush(...) and Btx.dispose() provide explicit lifecycle boundaries.

Open generated Dart API docsBrowse every public type and member shipped in the latest package.

Configuration and identity

BtxConfigurationSets the publishable key, features, app context, navigator integration, messenger options, and telemetry mode.

BtxFeatureSelects logs, messenger, and knowledge base capabilities.

BtxPublishableClientKeysMaps iOS bundle IDs and Android package names to publishable keys.

BtxAppContextAdds version overrides and low-cardinality host attributes.

BtxCustomerCarries the stable external ID plus optional name and email.

Customer messages and presentation

BtxMessengerFacadePresents messages, known threads, contextual compose flows, and host-created threads.

BtxLaunchContextAdds conversation purpose, entry point, source, title, intro, attributes, and thread metadata.

BtxConversationPurposeDistinguishes replyable support and feedback threads.

BtxClientThemeStyles messenger colors, typography, artwork, controls, and links.

BtxMessengerSheetConfigurationConfigures labels, height, density, radius, barrier, and hidden-surface reply banners.

BtxHostMounts facade-owned messenger and knowledge base UI in the host widget tree.

The package also exports BtxThread, BtxMessage, BtxAttachment, BtxImageInput, messenger state enums, snapshot types, and intro models for advanced host integrations.

Knowledge base

BtxKnowledgeBaseFacadePresents, searches, dismisses, and opens help articles.

BtxKnowledgeBaseArticleRouteIdentifies an article by category, section, and article slugs.

Knowledge base modelsRepresent navigation, categories, sections, articles, revisions, assets, search results, status, and errors.

Telemetry and feature flags

BtxLogLevelSelects info, warning, or error severity for Btx.log(...).

BtxTelemetryConfigurationControls lifecycle binding, initial app-session context, and main or worker runtime mode.

BtxCustomerSdkStatusReports runtime state and typed disable reasons.

BtxFeatureFlagsStateContains evaluated values, load state, revision, and evaluation time.

Push notifications

BtxAndroidPushSourceBinds host-owned token, refresh, launch, and notification-open callbacks.

BtxAndroidNotificationOpenCarries notification data plus an optional non-BTX fallback.

BtxPushCoordinatorExposes the lower-level iOS permission, registration, retry, event, and cleanup state for custom hosts.

Advanced surfaces

The package exports BtxCustomerSdk, BtxClientController, BtxCustomerSdkScope, BtxMessengerMount, BtxMessengerScope, and BtxMessengerView for tests, custom embedded UI, and intentionally direct runtime ownership.