CortexDB Docs
Connectors

Zendesk Connector

Ingest Zendesk tickets, comments, and help-center articles into CortexDB.

Tails Zendesk tickets (and their comments) and Help Center articles, and writes them to CortexDB as experiences.

Two ways to run this connector

Self-hostedpip install 'cortexdb-connectors[zendesk]' then cortexdb-sync sync zendesk. Managed — CortexDB runs the connector as a worker. See the Connectors overview.

1. Prepare credentials

Zendesk → Admin Center → Apps and integrations → Zendesk API → enable token access and create an API token. The connector authenticates as HTTP Basic (email/token:<token>). You also need your Zendesk subdomain (e.g. acme for acme.zendesk.com).

What gets written

Each ticket, ticket comment (as a conversation), and Help Center article (as a document) becomes a POST /v1/experience on the resolved scope (default org:<org>/source:zendesk), with an entity reference and metadata (status, priority, a source_url).

Idempotency key

The idempotency_key is zd:ticket:<id> / zd:article:<id>. This connector does not use context.preceded_by.

Run it yourself

pip install 'cortexdb-connectors[zendesk]'
pip install cortexdb-cli && cortexdb init

export ZENDESK_SUBDOMAIN=acme            # required
export ZENDESK_EMAIL=[email protected]        # required
export ZENDESK_TOKEN=...                 # required (API token)

cortexdb-sync --api-url http://localhost:3141 sync zendesk
cortexdb-sync --api-url http://localhost:3141 watch zendesk --interval 300

See also

On this page