This article details how to install the Swifteq Articles PDF Export app from the Zendesk Marketplace page.
In this Article
Installing the Articles PDF Export App or Installing your Free 14-day Trial
Setting the Title and Access Restrictions
Entering the Swifteq API Key
Swifteq API Key if you do not already have a Swifteq Account
Swifteq API Key if you already have a Swifteq Account
Adding the Swifteq API Key to the Articles PDF Export App Configuration in Zendesk
Completing the Installation
Logging into the App, Inviting Additional Users and Resetting your Password
Changing the Settings or Uninstalling
Installing the Articles PDF Export App or Installing your Free 14-day Trial
If you already have a subscription for Help Center Manager, the subscription to the Articles PDF Export app is included for free.
If you do not have a subscription for Help Center Manager you can install a free 14-day Trial of the app which allows you to export up to 100 articles. After the trial you can set up a subscription to the app.
The app needs to be installed by a Zendesk admin. The user who is installing the app either creates a Swifteq account or uses an existing Swifteq account, then configures the app. As part of the configuration, the Swifteq API key that is provided for your account needs to be added to the configuration. This allows your agents to access the app without needing a Swifteq account,
- Go to the relevant page for the app in the Zendesk Marketplace page.
You can search for the app or click the following link to take you directly to the page:
https://www.zendesk.com/marketplace/apps/support/1063243/articles-pdf-export/
- Click Install.
- Enter the Zendesk Account to install the app for and click Install.
-
If not already signed in to Zendesk, you are prompted to sign in with your Zendesk login.
Note: This is a Zendesk login for an admin. A Swifteq account is different from a Zendesk account. Once you have installed the app in the Zendesk account, you will then need to create a Swifteq account from the app and connect it to your Zendesk.
The settings for the Installation of the app display automatically in your Zendesk > Admin Center > Apps and Integrations > Apps for Zendesk Support Apps.
Setting the Title and Access Restrictions
- The Title defaults to the name of the app and you can change this if required.
- You can Enable Role Restrictions. When Role Restrictions are enabled, only users that have the selected Role(s) in Zendesk have access to the app.
Checkmark Enable role restrictions and the drop-down list displays all the Roles you have set up in your Zendesk Account. Select any Role(s) that you want to have access to the app.
The selected Role(s) display.
- You can Enable group restrictions. When Group Restrictions are enabled, only users in the selected Groups in Zendesk have access to the app.
Checkmark Enable group restrictions and the drop-down list displays all the Groups you have set up in your Zendesk Account. Select any Group(s) that you want to have access to the app.
Entering the Swifteq API Key
You need to enter your Swifteq API Key.
If you have not entered your API Key when you initially install the app, you need to change the settings of the app in your Zendesk > Admin Center > Apps and Integrations > Apps for Zendesk Support Apps and add the key.
Swifteq API Key if you do not already have a Swifteq Account
Click the following link to create a new account
agenthelper.swifteq.com/auth/exportPdfs
Enter your details and click Sign up.
Swifteq API Key if you already have a Swifteq Account
If you already have a Swifteq account you need to copy the Swifteq API Key.
- Login to your account as above with the existing account and then click Sign in.
- From the Switch between Swifteq Zendesk Apps button in the top right menu.
-
Select Articles PDF Export.
Note: If the screen for the Articles PDF Export app does not display, it may be displaying the app that you last used. Use the Switch Zendesk Apps again to switch to the Articles PDF Export. - From the Configure the app using this API Key, click the Copy to Clipboard icon.
Adding the Swifteq API Key to the Articles PDF Export App Configuration in Zendesk
Paste your Swifteq API Key into the Zendesk configuration from your Zendesk > Admin Center > Apps and Integrations > Apps for Zendesk Support Apps.
Completing the Installation
To complete the installation, click Install.
The My Apps page displays and Articles PDF Export shows in the Currently Installed apps.
When you have installed Articles PDF Export, it displays as an icon in the sidebar of the Zendesk Agent Dashboard.
Refer to Using Articles PDF Export.
Logging into the App, Inviting Additional Users and Resetting your Password
Refer to Logging into the Swifteq App, Inviting Additional Users and Resetting your Password in the section Installation for Swifteq Automation Apps.
Changing the Settings or Uninstalling
After installing, you can change the installation settings for the Title, Enable Role Restrictions or Enable Group Restrictions at any time. You do this by opening the app from your Zendesk Admin Center.
If you need to uninstall the app, you do this from the Zendesk Admin Center My Apps.