Source: https://docs.pageloop.ai/guides/freshdesk-integration

# Freshdesk integration

# Freshdesk integration

Connect Freshdesk so Pageloop can read your solution articles and prepare updates for review. You can also use resolved support tickets as read-only evidence for documentation gaps by assigning Freshdesk to the **Ticketing** role.

For an overview of help-center connections and integration roles, see [Connect your knowledge base](/guides/connect-knowledge-base).

## Before you begin

- Sign in to Pageloop as an **Admin**.
- Have your Freshdesk subdomain ready. For `<your subdomain>.freshdesk.com`, enter only `<your subdomain>`.
- Have `<your API key>` ready: use the API key of a Freshdesk agent whose role may publish solution articles without approval. If the agent's role requires publishing approval, Pageloop cannot publish live.
- If your help center uses a custom domain, have the hostname ready, such as `support.<your domain>`. Enter it in the configuration after connecting, not in **Subdomain**.

## Connect and configure Freshdesk

1. Open **Integrations**, find the **Freshdesk** card under **Knowledge base**, and select **Connect**.

   ![Freshdesk card in the Knowledge base section of Integrations, with Connect outlined](/images/uploads/uploaded-image-0-558087b1.png)

2. In **Connect Freshdesk**, enter **Subdomain** and **API Key**, then select **Connect**. The **Find your API Key** link opens Freshdesk's guide to locating the key. The **Integration Connected** toast with **Successfully connected to Freshdesk** confirms the connection.

   ![Connect Freshdesk dialog with sample values, a masked key, and Connect outlined](/images/uploads/uploaded-image-1-ef1cb4ed.png)

3. **Configure Freshdesk Integration** opens. If your help center uses its own domain, enter it in **Custom domain** so Pageloop recognizes links to your help center. Otherwise, leave the field blank. Select **Save Configuration**.

   ![Configure Freshdesk Integration dialog with a custom domain and Save Configuration outlined](/images/uploads/uploaded-image-2-a0e03ebf.png)

4. Check that the Freshdesk card reads **Connected**. Use the gear (**Configure**) button to change the custom domain later.

   ![Freshdesk card in the Knowledge base section reading Connected, with its Configure gear outlined](/images/uploads/uploaded-image-3-6873ea71.png)

The screenshots use a fictional company and sample credentials. The connected example shows both roles assigned; **Ticketing** is never assigned automatically.

### Assign integration roles

At the bottom of **Integrations**, **Integration roles → Knowledge base** identifies “Where Pageloop reads your articles from and publishes updates to.” Connecting Freshdesk assigns this role only when no service holds it.

If another service, such as **Pageloop Docs**, already holds the role, Freshdesk connects but does not sync articles until you change the assignment:

1. Under **Integration roles**, select **Change** on **Knowledge base**.
2. In **Change Knowledge Base**, select **Freshdesk**. The dialog says “Pick a connected service to read from and write to.”
3. Select **Save** and confirm that **Knowledge base** names **Freshdesk**.

To use resolved Freshdesk support tickets as evidence for documentation gaps, select Freshdesk under **Integration roles → Ticketing** and save. Use **Choose** if the role is not set, or **Change** if another service holds it. Ticket access is read-only and requires this separate assignment.

## What Pageloop reads and writes

### Read and sync articles

When Freshdesk holds the **Knowledge base** role, Pageloop reads your Solutions categories, folders, and articles and syncs them every hour. Freshdesk's API rate limits are shared with your other Freshdesk tools. Pageloop waits and retries when Freshdesk asks it to slow down.

### Review and publish updates

Pageloop's proposals arrive in the **Inbox**. Nothing reaches Freshdesk until a person publishes.

When publishing an article, choose its destination folder. Categories appear as headings; select a folder within a category. Then choose **Publish** or **Save as draft in Freshdesk**.

If your Knowledge base settings show **Default publish mode for Freshdesk**, choose **Draft** or **Live** to set whether published changes are saved as drafts in Freshdesk or go live. **Draft** is the safer default.

> [!WARNING]
>
> Publishing live over an article with an unpublished Freshdesk draft replaces or discards that draft. Pageloop warns you before proceeding. Review the warning before publishing.

## Disconnect Freshdesk

1. Point at **Connected** on the Freshdesk card. The button changes to **Disconnect**.
2. Select **Disconnect** to open **Disconnect Freshdesk?**. The dialog explains: “Pageloop stops reading from and writing to it.”
3. Review the role warning. When Freshdesk holds only the **Knowledge base** role, the dialog says “Freshdesk is your knowledge base integration. That role is left unassigned until you pick another.” The example below shows the warning when Freshdesk holds both roles.
4. Select **Disconnect** to confirm, or **Keep connected** to cancel. The **Freshdesk disconnected** toast confirms disconnection.

![Disconnect Freshdesk? dialog with Disconnect outlined](/images/uploads/uploaded-image-4-ea0f34df.png)

Disconnecting does not revoke anything in Freshdesk. Rotate or delete the API key in Freshdesk if you no longer want Pageloop to have access.

### Reconnect after losing access

If the key is deleted or syncing fails several times in a row, the card can show **Needs reconnecting**. The page explains: “Freshdesk needs to be reconnected. Pageloop lost access, so it is paused until you reconnect it.”

Open the **...** menu on the Freshdesk card and select **Disconnect**. Then select **Connect** and repeat [Connect and configure Freshdesk](#connect-and-configure-freshdesk). Confirm the intended integration roles after reconnecting.

## Troubleshooting

| Message or symptom                                                                                                                                                               | What to do                                                                                                        |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Connection Failed** with **Invalid Freshdesk API key**                                                                                                                         | Check the API key, the subdomain, and that the agent can access Solutions.                                        |
| **Connection Failed** with a network error                                                                                                                                       | Correct the subdomain. Enter only `<your subdomain>`, without `.freshdesk.com`.                                   |
| **Failed to load Freshdesk config** or **Freshdesk config not found for this integration**                                                                                       | Disconnect Freshdesk, then connect and configure it again.                                                        |
| Freshdesk is **Connected**, but articles do not sync.                                                                                                                            | Check **Integration roles → Knowledge base**. If another service holds the role, change it to Freshdesk and save. |
| **Needs reconnecting**                                                                                                                                                           | Follow [Reconnect after losing access](#reconnect-after-losing-access).                                           |
| “Pageloop can’t sign in to your Freshdesk help center, so it isn’t syncing.”                                                                                                     | Disconnect Freshdesk, then connect it again.                                                                      |
| “Pageloop stopped syncing your Freshdesk help center after it failed several times in a row.”                                                                                    | Disconnect Freshdesk, then connect it again.                                                                      |
| “The last sync of your Freshdesk help center didn’t finish. Pageloop keeps trying on its own.”                                                                                   | Pageloop retries automatically.                                                                                   |
| “Pageloop paused syncing: most of your Freshdesk articles were missing from the last read, so it kept them rather than delete them. If you didn’t remove them, contact support.” | If you did not remove the articles, contact support. Pageloop kept the articles rather than deleting them.        |
| Pageloop cannot publish live.                                                                                                                                                    | Check whether the API key owner's Freshdesk role can publish solution articles without approval.                  |

## Related guides

- [Connect your knowledge base](/guides/connect-knowledge-base)
- [Review an Inbox item](/guides/review-inbox-item)
- [Finish an Inbox item](/guides/finish-an-inbox-item)
- [Troubleshooting](/guides/troubleshooting)
