All Collections
How do I add custom content to HelpBar?
How do I add custom content to HelpBar?

Learn how to add user-generated content or content that is specific to your app

Tiago Mota avatar
Written by Tiago Mota
Updated over a week ago

HelpBar can hold more than documentation and helpful resources -- it enables users to access key pages or features, or even personal settings and team-wide projects. This will speed up their flow, their learning, and adoption of your product.

You can add user-generated content or product-specific content to HelpBar via our Dashboard, using our API. This enables the HelpBar to show dynamic results, that are based on your users' experience within your product.

πŸ§‘β€πŸ’» Ask an engineer for help: our API is easy to use and an engineer on your team can help set this up for you.

Availability & Usage

πŸ” Available on all plans

βš™οΈ Configure from the Dashboard

To add content that is specific to your product, head over to the HelpBar page in your Dashboard, and under Searchable content pick "Add individual items"

Pick a "Content Group" for your content and next screen switch to the "Via API" method.

Here you'll see the unique Group ID (for the one you just selected) -- this sets where your links will appear in search results. Below is the code snippet that you can adjust to send data to Chameleon as well as define permissions for users to access your content.

❢ First generate an API token from the Dashboard -- this will enable HelpBar to receive data from your app.

❷ Next, copy and adjust the code with your unique user data. Be sure to include the correct UID here. Below is an example πŸ‘‡ for a company report that will be available to all users.

curl -X PATCH -H 'X-Account-Secret: ACCOUNT_SECRET' -H 'Content-Type: application/json' \ -d '{"uid": "dashboards-413", "title": "Q3 Northstar metrics - final", "description": "See how we are tracking for Q3 and help hit goals" }' \ ''

You can also restrict the permissions so that only users on specific accounts see your results, by leveraging company_uids. Here's an example πŸ‘‡

curl -X PATCH -H 'X-Account-Secret: ACCOUNT_SECRET' -H 'Content-Type: application/json' \ -d '{"uid": "dashboards-413", "company_uids": ["d3fa1"] }' \ ''

Learn more about leveraging our API to enrich your HelpBar with user-generated content from our developer docs.

β„Ή You can leverage our API to delete content from HelpBar too.

Did this answer your question?