Help Center

Let customers find answers without leaving your app. Help Center presents your published articles in a native, searchable iOS interface.

Add .helpCenter to your existing startup configuration. This example keeps Customer Messenger enabled. Configuration and presentation run on the main actor.

BTX.configure(
    BTXConfiguration(
        publishableClientKey: "cfk_...",
        features: [.messenger, .helpCenter]
    )
)

BTX resolves the project automatically from your publishable key. Help Center also works without a signed-in account. If your app identifies a customer, it shares that identity with the other enabled BTX features.

Connect your Help Center button to the SDK-owned sheet:

BTX.helpCenter.present()

Customers can browse articles by category and section, search, and read formatted articles with images and media. Only published public articles are visible; drafts, archived articles, and internal content stay hidden.

Use BTXHelpCenter.systemImageName for the button's icon.

Open a pairing guide from your connection error screen. Set pairingArticleID to that published article’s ID in BTX. If the article is no longer published, the SDK shows an unavailable message.

BTX.helpCenter.presentArticle(id: pairingArticleID)

Pass these options through BTXConfiguration.helpCenterOptions during startup:

BTXHelpCenterOptions(
    title: "Help Center",
    sheetHeight: .half
)

The sheet starts full-screen by default. Choose .quarter or .half for a shorter starting height. It inherits messengerOptions.theme unless you supply a separate Help Center theme. See Theming.

For a host-owned SwiftUI layout, embed the view after configuration:

if let helpCenterView = BTX.helpCenter.view() {
    helpCenterView
}