HelpJuice Knowledge Sync
Integrate your team's knowledge directly from HelpJuice into Brainfish. By syncing your HelpJuice knowledge base articles, you can keep your AI agent's knowledge up-to-date automatically, ensuring it always provides the most accurate and relevant answers based on your customer support documentation.
This guide will walk you through the process of connecting and syncing your HelpJuice knowledge base as a knowledge source.
Step 1: Navigate to External Data and Add a New Source
From your Brainfish Dashboard, click on External Data in the left-hand navigation menu.
Click the + Source button.
From the list of external data sources, select HelpJuice.
Step 2: Configure Your HelpJuice Connection
You will now see the "Configure HelpJuice" form. You'll need to provide a name for this source and your HelpJuice credentials.
Source Name: Enter a descriptive name for your connection, such as "Customer Support Docs" or "Knowledge Base Articles".
HelpJuice Domain: Enter your HelpJuice account domain (e.g., "mycompany" for mycompany.helpjuice.com).
HelpJuice API Key: To get your API key, you'll need to generate one in your HelpJuice account. For detailed instructions on how to create an API key, please refer to the official HelpJuice documentation.
Note: The API Credentials settings page is only accessible to Super Administrators and Account Owners. The API key grants Super Administrator permission to any user who has access to it.
Paste the API Key: Return to Brainfish and paste the copied token into the HelpJuice API Key field.
Select Categories (Optional): After entering valid credentials, you can choose specific categories within your knowledge base to sync, or leave it as "All Categories" to sync everything.
Click the + Add Source button to finalize the connection.
Step 3: Sync and Verify Your Content
After adding the source, Brainfish will begin importing content from your HelpJuice knowledge base.
On the External Data page, you will see your new HelpJuice source with a "Syncing" status. This process may take a few minutes, depending on the amount of content.
Once the sync is complete, the status will update to show the number of articles imported.
Click on the newly created HelpJuice catalog to view the list of imported articles. You can click the eye icon (👁️) next to any article to preview its content and ensure it was imported correctly.
Step 4: Enable the Source for Your Agent
To start using this knowledge, you must enable the source and ensure your agent has access to it.
- On the External Data page, find your new HelpJuice source card. Click the three-dots menu (...) and ensure the source is Enabled.
- Navigate to the Agents page from the left-hand menu.
- Select the agent you want to train with this new knowledge.
- In the agent configuration panel, go to Knowledge Settings.
- Ensure that All sources is selected, or specifically add your new HelpJuice source from the dropdown menu.
Step 5: Test Your Integration
Finally, test that your agent can find and use information from the new source.
- Open the Agent Playground or your website where the agent is deployed.
- Ask a question related to the content in your synced HelpJuice knowledge base.
- The agent should provide a detailed answer based on the information from your HelpJuice articles. You can also expand the Sources to see the specific HelpJuice article that was used to generate the answer.
You have now successfully synced your HelpJuice knowledge base with Brainfish! Your agent will now be able to answer questions using the knowledge stored in your HelpJuice documentation.
Troubleshooting
Common Issues
"Invalid HelpJuice API Key" error
- Verify your API key is correct and hasn't expired
- Ensure the API key has the correct permissions
- Check that you copied the entire key without extra spaces
"Unauthorized" error
- Confirm your API key is valid and active
- Ensure your HelpJuice account is active and accessible
- Check that you have admin access to generate API keys
"No categories available" error
- Verify your HelpJuice account has knowledge base categories
- Check that your API key has access to the knowledge base
- Ensure your HelpJuice account has knowledge base enabled
"Domain not found" error
- Confirm the domain is correct (e.g., "mycompany" not "mycompany.helpjuice.com")
- Check that the domain exists in your HelpJuice account
- Ensure your API key has access to the specific domain
"Request timeout" error
- The sync process may take longer for large knowledge bases
- Check your internet connection
- Try again during off-peak hours
Support
If you encounter any issues during setup, please contact our support team with:
- Your HelpJuice account domain
- The specific error message you're seeing
- Screenshots of any error screens
For detailed HelpJuice API documentation, visit: https://help.helpjuice.com/en_US/API/284079-how-do-i-get-my-api-key
Integrate your team's knowledge directly from HelpJuice into Brainfish. By syncing your HelpJuice knowledge base articles, you can keep your AI agent's knowledge up-to-date automatically, ensuring it always provides the most accurate and relevant answers based on your customer support documentation.
This guide will walk you through the process of connecting and syncing your HelpJuice knowledge base as a knowledge source.
Step 1: Navigate to Knowledge and Connect a New Data Source
From your Brainfish Dashboard, click on Knowledge in the left-hand navigation menu.
Click the + Connect data source button.
From the list of external data sources, select HelpJuice.
Step 2: Configure Your HelpJuice Connection
You will now see the "Configure HelpJuice" form. You'll need to provide a name for this source and your HelpJuice credentials.
Source Name: Enter a descriptive name for your connection, such as "Customer Support Docs" or "Knowledge Base Articles".
HelpJuice Domain: Enter your HelpJuice account domain (e.g., "mycompany" for mycompany.helpjuice.com).
HelpJuice API Key: To get your API key, you'll need to generate one in your HelpJuice account. For detailed instructions on how to create an API key, please refer to the official HelpJuice documentation.
Note: The API Credentials settings page is only accessible to Super Administrators and Account Owners. The API key grants Super Administrator permission to any user who has access to it.
Paste the API Key: Return to Brainfish and paste the copied token into the HelpJuice API Key field.
Select Categories (Optional): After entering valid credentials, you can choose specific categories within your knowledge base to sync, or leave it as "All Categories" to sync everything.
Click the + Add Source button to finalize the connection.
Step 3: Sync and Verify Your Content
After adding the source, Brainfish will begin importing content from your HelpJuice knowledge base.
On the Knowledge page, you will see your new HelpJuice source with a "Syncing" status. This process may take a few minutes, depending on the amount of content.
Once the sync is complete, the status will update to show the number of articles imported.
Click on the newly created HelpJuice catalog to view the list of imported articles. You can click the eye icon (👁️) next to any article to preview its content and ensure it was imported correctly.
Step 4: Enable the Source for Your Agent
To start using this knowledge, you must enable the source and ensure your agent has access to it.
- On the Knowledge page, find your new HelpJuice catalog card. Click the three-dots menu (...) and ensure the source is Enabled.
- Navigate to the Agents page from the left-hand menu.
- Select the agent you want to train with this new knowledge.
- In the agent configuration panel, go to Knowledge Settings.
- Ensure that All sources is selected, or specifically add your new HelpJuice source from the dropdown menu.
Step 5: Test Your Integration
Finally, test that your agent can find and use information from the new source.
- Open the Agent Playground or your website where the agent is deployed.
- Ask a question related to the content in your synced HelpJuice knowledge base.
- The agent should provide a detailed answer based on the information from your HelpJuice articles. You can also expand the Sources to see the specific HelpJuice article that was used to generate the answer.
You have now successfully synced your HelpJuice knowledge base with Brainfish! Your agent will now be able to answer questions using the knowledge stored in your HelpJuice documentation.
Troubleshooting
Common Issues
"Invalid HelpJuice API Key" error
- Verify your API key is correct and hasn't expired
- Ensure the API key has the correct permissions
- Check that you copied the entire key without extra spaces
"Unauthorized" error
- Confirm your API key is valid and active
- Ensure your HelpJuice account is active and accessible
- Check that you have admin access to generate API keys
"No categories available" error
- Verify your HelpJuice account has knowledge base categories
- Check that your API key has access to the knowledge base
- Ensure your HelpJuice account has knowledge base enabled
"Domain not found" error
- Confirm the domain is correct (e.g., "mycompany" not "mycompany.helpjuice.com")
- Check that the domain exists in your HelpJuice account
- Ensure your API key has access to the specific domain
"Request timeout" error
- The sync process may take longer for large knowledge bases
- Check your internet connection
- Try again during off-peak hours
Support
If you encounter any issues during setup, please contact our support team with:
- Your HelpJuice account domain
- The specific error message you're seeing
- Screenshots of any error screens
For detailed HelpJuice API documentation, visit: https://help.helpjuice.com/en_US/API/284079-how-do-i-get-my-api-key