Skip to main content

​
Required Scopes

To configure a Sync for Zendesk, you need to request the following scopes from your Zendesk OAuth application: Files:
  • hc:read
Tickets:
  • tickets:read
  • organizations:read
  • users:read
Learn more about configuring scopes for your app in Adding Integrations.

​
Synced Objects

Zendesk supports the following Synced Objects:
  • Files: Syncs knowledge base articles from Zendesk.
  • Tickets: Syncs tickets from Zendesk.

​
Files

Send a request to Enable Sync to start a file sync of knowledge base articles from Zendesk.
Example
{
    "integration": "zendesk",
    "pipeline": "files",
    "configuration": {
        "locale": "en-us"
    }
}
Configuration options:
​
locale
string
A locale string to limit the Sync scope to articles in a specific language. If not specified, the Sync will use en-us as the default locale.

​
Tickets

Send a request to Enable Sync to start a ticket sync.
Example
{
    "integration": "zendesk",
    "pipeline": "tickets",
    "configuration": {}
}
Configuration options:
​
organizationId
string
A Zendesk Organization ID to limit the Sync scope to tickets from a specific organization.If not specified, the Sync will ingest all available tickets from the user’s Zendesk account.
⌘I