Integrations
Freshdesk Integration
Paligo can publish directly to Freshdesk, so you can use Paligo's powerful authoring features to create content, while still using your Freshdesk help center to support customers.
To find out how to set up Paligo to connect to Freshdesk see Paligo to Freshdesk.
If you want information about changing the publishing settings, see Freshdesk Layouts.
Paligo to Freshdesk
Paligo can publish directly to Freshdesk, so you can use Paligo's powerful authoring features to create content, while still using your Freshdesk help center to support customers.
When you set Paligo to publish to Freshdesk for the first time, there are some extra steps you need to take, such as setting up an API key and integration. Once these are in place, any further publications to Freshdesk will be much simpler - you will just publish and choose a Freshdesk layout.
To set Paligo to publish to Freshdesk for the first time complete steps 1-3:
Step 1: Get an API Key and Folder ID in Freshdesk
To connect to Freshdesk, Paligo needs an API key and a folder ID. You can find both of these in your Freshdesk.
Log in to your Freshdesk account.
NoteYou need to log in via a user account that has administrator permissions.
Select your profile to display a menu, and then select Settings.
On the Profile Settings page, make a note of the API Key. You will need to enter this key in Paligo.
Select Solutions, find the Category that you want Paligo to publish to, and then select the Folder that will contain the content. In Freshdesk, you can add new categories and folders if needed.
Select Solutions (1), find the Category (2), select a Folder (3).
NotePaligo publishes topics to a folder in Freshdesk. For this reason, you need to have a folder in place, and not just a category.
Select View on Portal (it is near the New Article button). The folder's page will display in the browser.
Make a note of the number at the end of the address in the browser. This is the folder ID and you will need to enter this in Paligo.
Next, you will add the API key and folder ID to the Freshdesk integration settings in Paligo.
Step 2: Connect Paligo to Freshdesk
When you have an API key and folder ID from Freshdesk, you can set up an integration in Paligo. The integration allows Paligo to connect to your Freshdesk and:
Import content when you first migrate from Freshdesk to Paligo
Publish content from Paligo to Freshdesk.
Log in to Paligo via a user account that has administrator permissions.
Sign in to Paligo using a user account that has administrator permissions.
Select the avatar in the top-right corner.
Select Settings from the menu.
Select the Integrations and webhooks tab.
In the Freshdesk box, select Add (or Change if an integration has been set up previously).
Enter the connection details for your Freshdesk:
Your Freshdesk url: Enter the web address of your Freshdesk. Note that the https:// prefix and .freshdesk.com suffix are already in place.
API key: Enter the API key into this field. Paligo and Freshdesk use the API key to authorise the connection.
Folder ID: Enter the folder ID for the Freshdesk folder. Paligo will copy and transfer the Paligo content to this folder. To find the folder ID, display the folder in Freshdesk and look at the URL in the address bar. The URL contains two IDs, one for the category and one for the folder. You need to use the second ID, which is the ID for the folder.
Select Save.
Select the Change button for the integration.
Select Test Settings to run a connection test.
If the settings are:
Correct, Paligo shows a green success notification.
Incorrect, Paligo shows a red failure notification.
Check each connection setting carefully, to make sure you have not made any mistakes and try again.
If the connection test continues to fail, contact Paligo support for assistance.
You have now set Paligo to connect to your Freshdesk. The next step is to publish content to Freshdesk.
Step 3: Publish your Paligo Content to Freshdesk
On the Settings tab, select HTML.
Choose the Freshdesk layout that you want your publication to use.
As this is your first time connecting Paligo to Freshdesk, we recommend that you choose the built-in Freshdesk layout.
Map Content from Paligo to Freshdesk
When you publish from Paligo top Freshdesk, Paligo will:
Create new articles in Freshdesk to match the topics in your publication
Update existing articles in Freshdesk with new content from the matching topics in Paligo.
This process of matching topics to articles and creating or updating them is called "mapping". In the following sections, you can learn how Paligo maps content to Freshdesk and how to troubleshoot common issues.
Map to Freshdesk's Category > Folder > Article Structure
Freshdesk content has to be organized into a Category > Folder > Article structure, where the Category is the type of information being provided, and Folder is for grouping related articles. For example, you could have a category about "Troubleshooting" and folders for "Connection Issues" and "Setup Issues". Paligo does not have this strict structure, but it does need to map content to it, and this is how it is done:
In Paligo's integration settings, there is a Folder ID. From this, Paligo can find out which Freshdesk Category and Folder should receive the content from Paligo (see Paligo to Freshdesk).
In your publication structure, you have top-level topics. These are mapped to articles in Freshdesk.
If your publication has lower-level topics, these topics are mapped as subsections in the articles. The heading level of the subsection corresponds to the topic-level in Paligo, so a level 2 topic in Paligo will have a higher heading level than a level 3 topic.
In the example image shown, the entire publication is mapped to a folder in a category. The top-level topics, "About ACME Smart Home" and "Quick Setup" are mapped to articles in Freshdesk. The second-level "Quick Setup Instructions" topic is mapped as a subsection in the "Quick Setup" article. The third-level "Install Smart Home Software" topic is mapped as a subsection of "Quick Setup Instructions".
When you create a publication to be published to Freshdesk, consider how Paligo maps the content into the Freshdesk structure. Organize your publication so that your content will map to folders and articles and give you the structure you want in Freshdesk.
You may get duplicate articles when you first publish to Freshdesk. To find out why this happens and how to resolve it, see Duplicated Articles when you Publish to Freshdesk.
If you have broken cross-references, see Map Cross-References from Paligo to Freshdesk.
Duplicated Articles when you Publish to Freshdesk
When you publish to Freshdesk for the first time, Paligo will "push" all of the topics in a publication into Freshdesk. There is no mapping with this first publish. Instead, Paligo creates new articles for the topics. So if you already have those articles in Freshdesk, you will have duplicate articles.
To solve this problem:
Delete the articles that were originally created in Freshdesk
Keep the articles that Paligo created automatically in Freshdesk.
This will leave only the articles that Paligo created for you. Paligo recognizes the articles it created and so when you next publish to Freshdesk, Paligo can update those articles rather than create new ones.
Paligo can only update articles that it created. It cannot update articles that were originally created in Freshdesk. This is because when you publish content from Paligo to Freshdesk for the first time, Paligo keeps a record of the topics and articles. It uses the record to track the relationships between the topics in Paligo and the articles it creates in Freshdesk.
Map Cross-References from Paligo to Freshdesk
When you first publish from Paligo to Freshdesk, you may get broken links. This is because when Paligo creates an article in Freshdesk, if it contains a link, the link will only work if the target article exists too. But the target article may not have been created yet in the publishing process. If you have this problem, publishing from Paligo twice should solve it.
In the first publish, Paligo will create the articles, but may not be able to resolve all of the links.
In the second publish, all of the articles will exist in Freshdesk, so Paligo can then resolve the links.
If you still have problems with broken cross-reference links, contact Paligo support for assistance.
Freshdesk Layouts
To publish content from Paligo to Freshdesk, you will need to use a Freshdesk layout. Think of layouts as a collection of settings that Paligo will apply to your content when you publish.
For publishing to Freshdesk, Paligo uses Freshdesk Layouts, which are special types of HTML layout. They are based on the layouts that Paligo uses for Zendesk.
A Freshdesk Layout is for defining how Paligo features and content are published to Freshdesk. They are not used for styling the content in Freshdesk.
To get you started, Paligo includes a built-in Freshdesk layout and you may find that its default settings are suitable for your requirements.
But you can also create your own Freshdesk layouts.
Create a Freshdesk Layout
Paligo has a built-in Freshdesk layout that you can use for publishing. But if you need to apply different publishing settings, you can create your own Freshdesk layout, customize it, and use that instead.
To create a Freshdesk layout:
Select Layout.
Select Create New Layout.
In the Layout Title field, enter a name for the new layout. Set the Output Format to Freshdesk and then select OK.
Paligo creates your new Freshdesk layout. If you select it on the Layout page, you can edit its settings.
The Freshdesk layout has General, Toc and chunking, Classes and attributes, and Verbatim (code and software) tabs. These settings work in a similar way to those on the HTML5 layout, see HTML5 Layout Editor Options.
The Toc and chunking settings do not apply to Freshdesk. When you publish content to Freshdesk, top-level topics are mapped to articles. Any lower-level topics are embedded in their "parent" top-level topic.
Publish to Freshdesk
If your publication has topics organized into different levels, the top-level topics will map to a Freshdesk article. The lower-level topics will be embedded inside their "parent" top-level topic.
To publish your content to Freshdesk:
Select the dotted menu (...) for the topic or publication in the Content Manager.
Select Publish.
Paligo displays the Publish document dialog.
On the Settings tab, select HTML.
Choose the Freshdesk layout that you want your publication to use.
As this is your first time connecting Paligo to Freshdesk, we recommend that you choose the built-in Freshdesk layout.
In the Folder ID field, enter the ID of the folder you want to publish to. The default folder for publishing is the folder set in the Integration settings.
Select the languages to be published.
NoteIf no translations are available, only the Source Language will show. If you have multiple languages translated and approved, you can select which ones to include. Paligo will publish each language as a separate output.
For PDF output you can publish them as one multilingual publication, check the Combine selected languages box.
If your content is set up to use Filtering / Profiling, use the Profiling attributes section to apply them. [Optional]. If you do not use filtering, ignore this setting.
Select Edit and then choose the value for each filter that you want Paligo to use. For example, for Audience, choose Expert to include content that is marked as for expert users.
If you do not want to apply a filter, leave the field blank.
Select OK to add your chosen profiling attribute(s).
If your content is set up to use Variables in Paligo , choose which variants to apply (optional).
Select Edit and then for each variable, choose the variant (value) that Paligo should apply to your publication.
If you do not want to apply a variable, leave the field blank.
Select OK to add the selected variables.
Use the Output filename section to control the filename.
By default, Paligo will use the filename syntax that is defined in the System Settings.
To change the information included in the filename, enter your preferred format in the publishing settings. Default is:
ID-Title-Format.You can use:
ID - The ID of the document.
Title - The title of the publication or topic that you are publishing.
Format - The name of the output format, for example, PDF or HTML5.
Edit date - The date that the publication or topic was last edited.
Branch label - The text from the branch label for the publication or topic. This only applies if your content has been branched and it has a branch label. For details, see Add or Edit Branch Labels.
Unique value - A random string of characters, generated by Paligo, that is added to the filename to make it unique. This can stop the file from being overwritten by later publishes of the same document.
TipIf you type @ into the field, Paligo displays a list of the available values and you can select from the list. To remove a value, click in it and use the delete key or backspace key to remove all of its characters.
NoteThe filename shown in the top-right corner is a preview of the filename that Paligo will use when you publish.
Set the Optional Parameters (leave unchecked if you do not want these features):
Save the output in Paligo - Check the box to save the zip file that Paligo creates when you publish. The zip file will be available from the Resource View and you can download it from the Saved Outputs tab. Clear the box if you don't want Paligo to store the zip file.
Notify me - Check this box if you want Paligo to send you an email when the publication is ready. This is useful if you have very large publications that can take a longer time to process and publish.
Make debug build - Check this box if you want Paligo to include a log file and link report. If there is an issue with your content, Paligo support may ask you to enable this feature so that they can use the log files to investigate.
Select Publish Document.
Paligo starts processing your content and applies your layout and publishing settings. The time that this takes varies depending on how much content you are publishing (the more content, the longer it takes).
A progress bar appears. Select the arrow to hide the progress bar and reopen it by selecting the progress clock in the top menu. To abort the publish, select the X.
The published output appears as:
A ZIP file with the published output appears in the downloads folder on your computer.
If you have altered your browser's settings to store downloaded files somewhere else, the zip file will be found there instead.
If you are using a publishing integration, the zip file will also be sent to the relevant service.
A link in the Activity Feed Panel to download the published content.
NoteTo make the content available online, first unzip the file. You can then use the file locally or you can use an FTP client, such as Filezilla, to upload the unzipped content to a web server.
TipYou can save your publishing settings and reuse them to achieve a smoother publishing process, see Publishing Settings. Any settings you save can also be used for Batch Publishing.
Paligo "pushes" the content in the publication to Freshdesk. Your content is mapped to the folder that matches the Folder ID and new articles are created. Note that Paligo can create new articles, but it does not delete articles.
If you already have content in your Freshdesk, you may get duplicate articles the first time you publish from Paligo. You must keep the ones Paligo created, see Map Content from Paligo to Freshdesk.
If you publish and there are broken cross-reference links, you may be able to solve this problem by publishing again. To find out more, see Map Content from Paligo to Freshdesk.