Zendesk Integration

Connect your Zendesk account to index support tickets, knowledge base articles, and customer data.

Quick Start

const connector = await client.createConnector({
  connector_type: 'zendesk',
  display_name: 'Company Zendesk',
  credentials: {
    subdomain: 'company',
    email: 'admin@company.com',
    api_token: 'xxxxxxxxxxxx',
  },
});

await client.syncConnector(connector.connector_id, true);

Authentication

API Token

{
  "credentials": {
    "subdomain": "company",
    "email": "admin@company.com",
    "api_token": "xxxxxxxxxxxx"
  }
}

OAuth 2.0

GET /v1/connectors/zendesk/oauth-url

Synced Content

Content Type	Description	Indexed Fields
Tickets	Support requests	Subject, Description, Comments
Articles	Help center content	Title, Body, Labels
Users	Customer data	Name, Email, Organization
Macros	Response templates	Title, Actions

Configuration

{
  "settings": {
    "include_closed_tickets": false,
    "ticket_status": ["new", "open", "pending"],
    "article_locales": ["en-us"],
    "include_internal_notes": true
  }
}

Example Queries

// Find tickets about billing issues
const results = await client.query({
  text: 'billing invoice payment failed',
  filters: {
    connector_type: 'zendesk',
    document_type: 'ticket'
  }
});

Webhooks

Real-time sync via Zendesk triggers:

• Ticket created
• Ticket updated
• Article published

Rate Limits

• API calls: 400 requests/minute
• Automatic backoff handling

Next Steps

• Freshdesk Integration
• Intercom Integration