Configuring the Zendesk Integration
Publishing to an external service requires the use of one site on your account. If you need additional sites on your account you can contact support to purchase additional sites.
1. Go to Account Settings > Integrations
- Select Account Settings
- Select Integrations
- Select Zendesk Help Center
2. Configure your connection
- Your Zendesk account name is the name at the front of your Zendesk URL. For example, if your help desk is at https://mycompany.zendesk.com then the account name would be '
Important: If you are using a custom domain name on your Zendesk account then you will need to enter the full domain name with protocol. For example:
- Your Zendesk host name is an optional parameter. This should be the host name where your customers come to view your Zendesk site.
- The email should be the email address you use to login to Zendesk
- You can retrieve your Zendesk API Token by following these instructions.
- The Locale setting defaults to US English. If you would like to push to a different language in your Zendesk account then you should set the locale here. Note that ScreenSteps can only push content to a single locale.
- Select Create.
You will be taken to your newly created ScreenSteps site that is connected to Zendesk.
3. Import structure
3.1. Select Import structure from Zendesk
From the Site Contents menu, select Import structure from Zendesk HC
3.2. Select Import
Confirm that you want to import your structure from Zendesk.
4. View imported manual
Select the manual title for one of the manuals that were imported from Zendesk.
5. Create or import articles
You should now see all of the Zendesk sections for the current manual in ScreenSteps.
You can now create new articles in ScreenSteps and have them published to Zendesk or import existing Zendesk articles to edit them in ScreenSteps.