Developer PortalChangelogPlatform StatusMore InformationJoin Discord

Create Zendesk Articles Feed

User Intent

"How do I sync Zendesk Help Center knowledge base articles? Show me Zendesk Articles feed configuration."

Operation

SDK Method: createFeed() with FeedTypes.Zendesk Auth: API token

Code Example (TypeScript)

import { Graphlit } from 'graphlit-client';
import { FeedTypes, FeedServiceTypes } from 'graphlit-client/dist/generated/graphql-types';

const graphlit = new Graphlit();

const zendeskSubdomain = process.env.ZENDESK_SUBDOMAIN!;
const zendeskToken = process.env.ZENDESK_ACCESS_TOKEN!;

const feed = await graphlit.createFeed({
  name: 'Help Center Articles',
  type: FeedTypes.Zendesk,
  zendesk: {
    type: FeedServiceTypes.ZendeskArticles,
    subdomain: zendeskSubdomain,
    accessToken: zendeskToken,
    readLimit: 200,
  },
  // Optional: add workflow for content processing
  // workflow: { id: workflow.createWorkflow.id }
});

console.log(`Created Zendesk Articles feed: ${feed.createFeed.id}`);

Configuration

type: FeedServiceTypes.ZendeskArticles subdomain: Zendesk subdomain (before .zendesk.com) accessToken: OAuth token or API token with read permissions readLimit: Number of articles to sync

Zendesk API Token Setup

  1. Zendesk Admin → Apps and integrations → API

  2. Enable OAuth or token access

  3. Create a client or generate a personal access token

  4. Store ZENDESK_SUBDOMAIN and ZENDESK_ACCESS_TOKEN securely before creating the feed

What Gets Synced

  • Knowledge base article titles and content

  • Article sections and categories

  • Article metadata (author, dates, status)

  • Article labels and tags

  • Article comments (if public)

ZendeskArticles vs ZendeskTickets

Use ZendeskArticles for:

  • Help Center content

  • Knowledge base articles

  • Self-service documentation

  • FAQ content

  • User guides

Use ZendeskTickets for:

  • Support tickets

  • Customer inquiries

  • Agent conversations

  • Ticket threads

Use Cases

Customer Support Knowledge Base:

type: FeedServiceTypes.ZendeskArticles,
subdomain: 'support'

Product Documentation:

type: FeedServiceTypes.ZendeskArticles,
subdomain: 'docs'

FAQ Database:

type: FeedServiceTypes.ZendeskArticles,
subdomain: 'help'

Related

Last updated

Was this helpful?