🛟 Help center

Happier customers, fewer support questions. What’s not to like? Make it easy for users to access information with our help center articles.

Show help center articles directly within the Gleap widget, to offer customers the help they need at the right place & time.

Open the help center by code

If you'd like to manually show the news section of the Gleap widget, you can do so by calling the following method:

Gleap.openHelpCenter({
    showBackButton: true
});

The first parameter showBackButton sets whether or not the main tabbar and back buttons will be shown.

Open a help center article by code

If you'd like to open a help center article directly withing the Gleap widget, you can do so by calling the following method:

Gleap.openHelpCenterArticle({
    articleId: "articleId",
    showBackButton: false
});

The first parameter articleId can be found at the bottom of your article editor in the Share this article banner.

The second parameter showBackButton sets whether or not the main tabbar and back buttons will be shown.

Open a help center collection by code

If you'd like to open a collection directly withing the Gleap widget, you can do so by calling the following method:

Gleap.openHelpCenterCollection({
    collectionId: "collectionId",
    showBackButton: false
});

The first parameter collectionId can be found at the bottom of collection in the Share this collection banner.

The second parameter showBackButton sets whether or not the main tabbar and back buttons will be shown.

Search your help center

If you'd like to search for help articles, you can do so by calling the following method:

Gleap.searchHelpCenter({
    term: "Search term",
    showBackButton: false
});

The first parameter term defines the search term, the Gleap SDK will look for to find related articles.

The second parameter showBackButton sets whether or not the main tabbar and back buttons will be shown.