HaloPSA Knowledge Base Sync

The HaloPSA integration with Hudu allows you to sync Knowledge Base articles from Hudu into HaloPSA.

What You'll Need

  • An active HaloPSA integration. See our HaloPSA integration setup guide to get started.
  • HaloPSA credentials with the Knowledge Base permissions listed below.

Integration Features

Sync Knowledge Base articles

Sync both Central and company-specific Knowledge Base articles from Hudu into the HaloPSA Knowledge Base.

Control Hudu attribution in Halo

Choose whether the "Article from Hudu" banner appears on the article body, moves to Halo internal notes, or is disabled. See Halo Configuration Options below.

   Knowledge Base article syncing requires credentials with the appropriate access and scopes. Refer to the FAQ – KB Article Sync below for additional details.

Required Permissions for KB Sync

API Permissions
  • If using Knowledge Base sync, you must enable:
    • read:kb
    • edit:kb
Agent Role Requirements
  • If using Knowledge Base sync, the Role must include:
    • Can create FAQ lists: Yes
    • Knowledge Base Access: Read, Modify, Delete
Knowledge Base Sync Requirements
  • Ensure Allow Articles to be added to FAQ Lists is enabled under Config → Knowledge Base.
image (5).png
    You must update or recreate your HaloPSA credentials before attempting to use the sync feature. The KB sync will not work without updated credentials that include the proper access and scopes.
  • Save the settings in HaloPSA.

   Synced Hudu articles and FAQ lists are always sent to Halo with "show for all" disabled, giving Halo admins direct control over per-record visibility within Halo.

Setting up the HaloPSA KB Sync

The Hudu/HaloPSA integration allows you to sync your Hudu Central KB and/or specific company KBs from Hudu to Halo.

  • Enable Sync Central KB to sync global articles.
  • To sync company KBs, select Add All Companies or manually add specific companies.
  • Save selections to enable syncing.
Screenshot 2026-02-25 140131.png
    To sync newly added articles before the next automatic sync, use the Active Integrations dropdown instead of the Start and Stop options. Stopping and restarting the integration will unlink all currently synced articles and restart the knowledge base sync from scratch.

Halo Configuration Options

These optional settings are available in the Halo integration settings and control how synced articles and FAQ lists behave inside Halo.

FAQ list access control

The Additional Halo Team & Agent Role for FAQ lists Access Control (Optional) dropdown controls who can access FAQ lists the integration creates. The Halo agent associated with the API key used in the integration is automatically assigned as the Owner Agent of any FAQ lists the integration creates.

halo_config_options.png
  • No role selected: When a new KB article is synced to Halo and creates a new FAQ list, only the Owner Agent is added to the access control settings for that FAQ list.
  • Role selected: When a new FAQ list is created during sync, both the Owner Agent and the selected role (with read-only access) are added to the new FAQ list access settings.
Hudu attribution

When Hudu syncs an article to Halo, it includes an "Article from Hudu" attribution banner. The banner lets readers know the article is managed in Hudu, that edits made in Halo will be overwritten on the next sync, and links back to the original article in Hudu. Use the Hudu attribution setting to control where this banner appears.

  • Article body (default): The banner appears at the top of the article body in Halo. It is visible to anyone who can view the article, including end users in Halo's self-service portal.
  • Halo internal notes: The banner is moved out of the article body and into the article's internal notes in Halo. Agents still see that the article is managed in Hudu, but end users do not.
  • Disabled: No attribution banner is added to the article.

   Existing integrations keep the default behavior until the setting is changed. After saving a new selection, each article picks up the change on its next sync; a full re-sync is not needed.

    Do not stop and restart the integration to apply this setting. Stopping and restarting unlinks all currently synced articles and restarts the knowledge base sync from scratch.

    If you disable attribution, let your Halo agents know that synced articles must be edited in Hudu. Without the banner, there is no in-article reminder that changes made in Halo will be overwritten.

FAQ – KB Article Sync

Do articles sync both ways between Hudu and Halo?

Answer: No. Articles sync from Hudu to Halo only. Changes made in Halo will be overwritten during the next sync.

Where should I make edits to synced articles?

Answer: All edits must be made in Hudu. Editing an article in Halo will not persist; it will be replaced by the Hudu version on the next sync.

Do I need to manually refresh the Halo integration every time I update an article?

Answer: No. You can manually start a sync by refreshing the integration, but it is not required. Halo automatically receives updates from Hudu without manual intervention.

What happens after I edit or publish an article in Hudu?

Answer: If you edit a synced article or publish a new one in Hudu, it automatically syncs to Halo. Updates are not always instant; timing depends on other jobs, but the article will update on its own shortly.

Do PDF articles sync to Halo?

Answer: Yes. PDF articles sync, and in Halo a copy of the PDF becomes an attachment on the article, provided it fits under Halo's file size limit. If the file is too large, it will not sync and you will see an error in the Hudu integration logs.

Do draft articles sync to Halo?

Answer: No. Draft articles are not synced to Halo until they are published in Hudu.

Why is my initial sync taking a long time?

Answer: The first-time sync of a Central KB or a company KB can take a while. The more articles you have, the longer the job will take. Syncing is automatic but not instantaneous.

How can I tell if an article has successfully synced to Halo?

Answer: In Hudu, synced articles display a "synced to Halo" badge at the top. In Halo, what you see depends on your Hudu attribution setting: an "Article from Hudu" banner at the top of the article body (default), the attribution in the article's internal notes, or no attribution if disabled.

Can I hide the "Article from Hudu" banner from end users?

Answer: Yes. In the Halo integration settings, set Hudu attribution to Halo internal notes to keep the banner visible to agents only, or to Disabled to remove it entirely. The change applies to each article on its next sync.

Why am I seeing a 403 Forbidden error for Failed to remove article from Halo?

Answer: Halo's API does not currently support deleting knowledge base articles. When Hudu attempts to remove an article during sync, Halo returns a 403 Forbidden error and the article remains in Halo.

Permissions are correct, but I'm seeing a 400 Bad Request error in the integration logs. What does this mean?

Answer: If permissions are correct on the API key and the assigned agent, navigate to HaloPSA → Configuration → Knowledge Base → Configure FAQ lists → (Name of Hudu FAQ list) → Edit, and ensure that Use this FAQ list for grouping other FAQ lists is enabled. Make sure the appropriate FAQ list (folder) is selected under FAQ Group.

Why am I seeing an error about skipping an attachment because it's too large?

Answer: Hudu and Halo have different maximum file size limits. If an attachment exceeds Halo's 25 MB limit, it cannot be uploaded during sync and will be skipped.

When a public link is enabled in Hudu, the attachment is not uploaded to Halo. Instead, Halo receives a URL that links back to the file hosted in Hudu.

Why am I seeing a 500 error on the /KBArticle endpoint in the logs when all permissions are confirmed correct?

Answer: In Halo, disable AI duplicate detection when creating Articles based on the AI generated summary.

Was this article helpful?
0 out of 0 found this helpful