How to Integrate Third-Party Apps into Your KB
Learn how to seamlessly incorporate external applications into your knowledge base for enhanced functionality and efficiency
Table of Contents
Overview of Third-Party App Integrations Integrating Third-Party Apps Overview of Customization Pages Main Layout (Always Rendered) Index Page Question Page Category Page Contact Form Thanks Page Best PracticesHelpjuice allows you to integrate third-party applications to extend the functionality of your knowledge base. This guide walks you through adding apps, configuring the integration, and best practices to ensure smooth operation.
In this article, you’ll learn:
- Overview of integrating third-party apps with Helpjuice
- How to connect and authorize apps
- Configuring app settings and permissions
- Tips and best practices for managing integrations
Overview of Third-Party App Integrations
Integrating third-party apps into Helpjuice lets your team:
- Bring external content or functionality directly into your KB.
- Improve efficiency by connecting commonly used tools to Helpjuice.
- Automate workflows, reduce repetitive tasks, and centralize information.
Helpjuice's customization framework is built on the Liquid Markup Language, giving you complete control over how your knowledge base is rendered. You can customize everything - from the layout of questions and articles to category pages, contact forms, and the knowledge base's index pages.
For instance, you may want to use third-party tools like WuFoo for contact forms or set up contact form submissions to automatically feed into your ticketing system.
Integrating Third-Party Apps
If your third-party app supports JavaScript or iFrame embedding, you can integrate it into Helpjuice yourself. This flexibility allows you to connect a wide range of external tools and platforms, from CRM systems to survey platforms.
If you need assistance or prefer not to handle the integration yourself, just submit a Customization Request.
Overview of Customization Pages
In the Helpjuice customization section, you'll see several options on the left-hand side of the page, including the Main Layout and individual page templates. Here's a breakdown of what each page represents and how you can use them to customize your knowledge base:
Main Layout (Always Rendered)
The Main Layout serves as the template that applies default styling and structure to your entire knowledge base. This is where you'll customize the overall look and feel of your site. It contains a critical Liquid tag {{ content_for_layout }}, which renders content from individual pages like the Index Page, Question Page, and more, depending on the user's location.
Index Page
This page is displayed when a user visits the homepage or "index" of your knowledge base. It's the first impression of your knowledge base and can be tailored to reflect your brand's design and structure.
Question Page
The Question Page is rendered when a user views a specific article or question. You can customize how individual articles are presented, from the layout to additional widgets or integrations.
Category Page
When users click on a specific category or topic, the Category Page is displayed. Here, you can customize the category page and how articles are listed to visitors.
Contact Form
The Contact Form page appears when a user searches for something in the knowledge base but doesn't find a result. It allows users to reach out with questions directly.
Thanks Page
After a user submits the contact form, they are directed to the Thanks Page. This page confirms that the form submission was successful and can be customized with messaging or additional calls to action.
Best Practices
- Regularly review connected apps to ensure they are still necessary and secure.
- Document API keys, tokens, or credentials used for integrations.
- Monitor article and workflow usage to identify which integrations add value.
- Keep third-party apps and Helpjuice accounts up-to-date to prevent sync issues.