Confluence to Zendesk Sync Docs

This page summarizes the Confluence to Zendesk Sync add-on's capabilities, guides you through the process of how to get started, and states common questions and scenarios:

How does it work
How to get started
- Installation
- Configuration
What can be synced
Macro Support

How does it work

The Knowledge Sync add-on utilizes Atlassian's API endpoints to enable synchronizing Confluence pages to your Zendesk Guide.

Once a page has been synced to your Zendesk Guide, it will automatically be updated whenever one of your Confluence users changes the Confluence page.

Note:

The add-on will not sync any content unless it's been explicitly activated
The add-on itself does not store any of your Confluence page content, it only stores page ids to identify the pages that need to be synced

How to get started

Installation

The add-on can be installed from the Atlassian marketplace. This can be done in two ways:

From within your Confluence instance by opening the Find new add-ons page in your Confluence Administration page. This page enables you to search and install the Knowledge Sync add-on
From the public Atlassian marketplace listing by clicking the "try it free" button

Configuration

Step 1: Set your Zendesk Help Center Sync Credentials

The configuration page has a form with 3 configuration fields:

Zendesk Subdomain
Your Zendesk Help Center URL handle. For example if your help center is at https://kolibri.zendesk.com/ enter kolibri.
If your Zendesk Help Center has a custom URL (ie support.yourdomain.com ) learn how to find your Zendesk subdomain here
Zendesk Agent E-Mail
The e-mail address you use to log in at your Zendesk Help Center.
Note: Make sure the Zendesk user has permissions to read and write articles for the Zendesk sections where you want to sync to
Zendesk API Token
The API token is Zendesk's recommended way of accessing their API so you don't have to give away your account credentials to third parties. Learn how to create an API token here.
You can deactivate an API token at any time in your Zendesk settings.

If you have any questions or need assistance with your configuration let us know, we're always happy to help and usually respond within 24 hours!

Step 2: Start Syncing

In order to start syncing, open any of your Confluence pages and look for the Knowledge Sync icon:

A click on the icon opens the page's synchronization options.
If you haven't configured your Zendesk API credentials yet, it will show an error message, otherwise it will show a dropdown to select a destination to sync to. Confluence Zendesk Sync Button

Select a section and click the "Start synchronization" button to initiate the synchronization process.

Note: This may take some time depending on the size of the page you are trying to synchronize

Once a page has been synced you will see a success message: Confluence Zendesk Sync Success Message

What can be synced

The add-on supports syncing all the primary content types that can be added to a Confluence page via the standard editor interface.

A General Rule of Thumb
Content that can be exported as a PDF with Confluence's PDF export can be synced to your Zendesk Guide.

content types that can be synced to Zendesk

Page Title
The Confluence page title will be used as Zendesk article title
Page Text content
All user-authored text content can be synced
Text Styles
Text styles will be retained
Images
All images embedded in a Confluence page can be synced
Tables
Table content and structure will be synced.
Some tables might require tweaking styles
Macros
Learn more about Macro Support

Macro Support

The Knowledge Sync add-on officially supports syncing content of most of the standard Confluence macros as well as some Third-Party Macros:

Macro Name	Supported?	Note
Standard Macros
Anchor Macro	Supported
Code Block Macro	Supported *	Content sync supported out of the box. Syntax highlighting requires tweaking
Excerpt Include Macro	Supported *	Content sync supported out of the box. Styles require tweaking
Expand Macro	Supported *	Content sync supported out of the box. Styles require tweaking
Info, Tip, Warning, Note, Panel Macro	Supported *	Content sync supported out of the box. Styles require tweaking
Page Tree Macro	Supported
Table of Contents Macro	Supported *	Content sync supported out of the box. Styles require tweaking
Third-Party Macros
draw.io Diagrams for Confluence	Supported

If you're using a macro that is not in the list above but is critical to your business to be synced:
Let us know, we'd be happy to look into supporting it!