The Zendesk connection will keep your Zendesk site's articles in sync.

Creating a Connection

  1. First, follow our guide to Create your Zendesk credentials

  2. Select Zendesk from the Connector Dropdown

  3. Fill out the form with your Domain, Email and API Token

  4. Once you submit, you will be redirected to a new page

  5. Select an API key from the dropdown at the top. All documents created by the connection will be attributed to the selected API key.

  6. Check "Articles" to make sure Articles are synced. Other data will be available in the future.

  7. Fill out any metadata you want to associate with the files in the folder. You can use this to filter the data later. This is in JSON format. You can leave it blank, or you could set it to something like

    1. {
        "company": "acme"
      }
      

  8. Select an Import mode. This is only applicable for PDFs. Fast only extracts text, but Hi-res also extracts images and tables. Fast can be up to 20x fast than Hi-res

  9. Enter a name for your partition where you want your documents to live.

  10. Click "Create Connection" at the top right.

You will be taken back to the connectors page, and the system will schedule a sync process for you as soon as possible.

What is synced?

Articles

All published Zendesk articles are synced. Drafts are not synced.

Metadata

The following metadata is added for each article


NameDescriptionExample
document_sourcezendeskzendesk
document_nameThe name of the article (limited to 50 characters)What_are_these_sections_and_articles_doing_here?.md
created_atWhen the article was ingested into Ragie2025-04-16T01:53:18+00:00
_source_created_atWhen the article was created in Zendesk. Since Unix Epoch.1744768398
_source_updated_atWhen the document was last updated in Zendesk. Since Unix Epoch.1744768398
source_urlLink to the articlehttps://ragieai.zendesk.com/hc/en-us/articles/36034951574939-What-are-these-sections-and-articles-doing-here
upvotesNumber of upvotes the article has5
downvotesNumber of downvotes the article has2
vote_countTotal number of votes7
author_nameName of article author, if available.John Smith
author_emailEmail of article author, if available[email protected]
external_idThe id of the Zendesk article from Zendesk36034951574930
object_typeAn array indicating the object types["article"]
source_typezendeskzendesk