Docs
Connectors

Zendesk connector

Customer service platform for tickets, users, organizations, and support activity.

View Markdown

Use this as an implementation starting point: adapt the worked example to the requested dataset and the source documentation. See Custom API for the shared SDK pattern and document-upload workflow.

What this connector is for

Customer service platform for tickets, users, organizations, and support activity.

A connector owns access to the source. Separate syncs shape selected resources into tables for analysis and downstream transformations using the Python SDK.

Data and tables you can pull

These are representative dataset families to consider, not a claim that the worked example implements every resource. Access, fields, and availability depend on the source account, product edition, and permissions. Use the vendor reference to select concrete resources.

Suggested tableOne row represents
ticketsa ticket
usersa user
organizationsa organization
ticket_commentsa ticket comment
ticket_auditsa ticket audit
groupsa group

Relationships and extraction considerations

Choose stable object IDs and preserve references between related resources. Nested arrays may need child tables. The listed names are proposed output datasets; validate the actual endpoint, fields, permissions, and pagination before adding each sync.

Connecting to Zendesk

Uses Basic authentication with email/token as username and an API token as password. Cursor pagination lists visible tickets; deleted tickets and historical event export use other endpoints.

Additional resources may require additional scopes. Connection settings belong to the connector; dataset filters and resource selection belong to each sync. See the CLI workflow for registration and configuration.

Connection settings used by the example

SettingRequirementPurpose
emailRequiredEmail
api_tokenRequired; secretAPI Key
subdomainRequiredSubdomain

requirements.in

Save these dependencies in requirements.in alongside connector.py; the example includes packages used by its sync. Install the published vortexify package for local development. Keep sync-specific dependencies in the sync's own requirements.in when splitting the implementation into separate resources.

vortexify==0.1.1
httpx>=0.27,<1
pandas>=2,<3

No separately installed database driver is needed by this HTTP example.

Worked example: sync tickets

tickets — Full read using the API's native pagination.

The complete files below implement only this example resource. They illustrate the current SDK signatures, a separate preview, bounded DataFrame output, and source-specific extraction. They do not establish complete source coverage. Live credentials and platform ingestion have not been used to validate this guide.

With default paths, place the connector files in connectors/zendesk-support/ and sync files in connectors/zendesk-support/syncs/tickets/. Use your project configuration if it specifies different paths.

Connection schema: config.json

This file contains a JSON Schema, not actual credential values. Provide those through platform configuration.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "minLength": 1,
      "title": "Email",
      "order": 0
    },
    "api_token": {
      "type": "string",
      "title": "API Key",
      "minLength": 1,
      "x-vortexify-secret": true,
      "order": 1
    },
    "subdomain": {
      "type": "string",
      "minLength": 1,
      "title": "Subdomain",
      "order": 2
    }
  },
  "required": [
    "email",
    "api_token",
    "subdomain"
  ]
}

Connector: connector.py

import httpx
from vortexify import Column, Connector, DiscoveredTable


class ZendeskSupportConnector(Connector):
    vendor_domain = "zendesk.com"

    def client(self):
        if self._client is None or self._client.is_closed:
            self._client = httpx.Client(
                base_url="https://" + self.config["subdomain"] + ".zendesk.com/api/v2/",
                headers={"Accept": "application/json"},
                auth=(self.config["email"] + "/token", self.config["api_token"]),
                timeout=60,
                follow_redirects=False,
            )
        return self._client

    def check(self) -> bool:
        cfg = self.config
        page_size = 1
        path = "tickets.json"
        params = {"page[size]": page_size}
        response = self.client().get(path, params=params)
        response.raise_for_status()
        payload = response.json()
        return True

    def discover(self) -> list[DiscoveredTable]:
        return [
            DiscoveredTable(
                name="tickets",
                schema=[
                    Column(name="id", type="integer"),
                    Column(name="subject", type="string"),
                    Column(name="status", type="string"),
                    Column(name="updated_at", type="timestamp"),
                    Column(name="document", type="string"),
                ],
            )
        ]

    def close(self) -> None:
        if self._client is not None:
            try:
                self._client.close()
            finally:
                self._client = None

Sync schema: syncs/tickets/config.json

{
  "type": "object",
  "properties": {},
  "required": []
}

Sync: syncs/tickets/sync.py

from collections.abc import Iterator
from math import isfinite
import json
import pandas as pd
from vortexify import Sync


class ZendeskSupportTicketsSync(Sync):

    def preview(self) -> pd.DataFrame:
        cfg = self.connector.config
        page_size = 100
        path = "tickets.json"
        params = {"page[size]": page_size}
        response = self.client.get(path, params=params)
        response.raise_for_status()
        payload = response.json()
        records = payload["tickets"]
        if not isinstance(records, list) or any(
            (not isinstance(record, dict) for record in records)
        ):
            raise ValueError(
                "Unexpected API record shape; refusing a partial successful sync"
            )
        records = records[:100]
        rows = []
        for record in records:
            row = {
                "id": record.get("id"),
                "subject": record.get("subject"),
                "status": record.get("status"),
                "updated_at": record.get("updated_at"),
                "document": json.dumps(record, ensure_ascii=False, default=str),
            }
            rows.append(
                {
                    key: (
                        json.dumps(value, ensure_ascii=False, default=str)
                        if isinstance(value, (dict, list))
                        else value
                    )
                    for key, value in row.items()
                }
            )
        return pd.DataFrame(
            rows,
            columns=["id", "subject", "status", "updated_at", "document"],
            dtype=object,
        )

    def extract(
        self, *, avg_row_size_bytes: float | None = None
    ) -> Iterator[pd.DataFrame]:
        memory_mib = self.compute.memory if self.compute else None
        memory_mib = memory_mib if memory_mib is not None and memory_mib > 0 else 1024
        target_bytes = min(16 * 1024 * 1024, max(1, memory_mib * 1024 * 1024 // 20))
        batch_size = 100
        if avg_row_size_bytes is not None:
            if not isfinite(avg_row_size_bytes) or avg_row_size_bytes <= 0:
                raise ValueError("avg_row_size_bytes must be finite and positive")
            batch_size = max(1, int(target_bytes / max(1.0, avg_row_size_bytes) / 4))
        batch_size = min(batch_size, 100)
        cfg = self.connector.config
        page_size = batch_size
        path = "tickets.json"
        params = {"page[size]": page_size}
        seen_pages = set()
        while True:
            response = self.client.get(path, params=params)
            response.raise_for_status()
            payload = response.json()
            records = payload["tickets"]
            if not isinstance(records, list) or any(
                (not isinstance(record, dict) for record in records)
            ):
                raise ValueError(
                    "Unexpected API record shape; refusing a partial successful sync"
                )
            rows = []
            for record in records:
                row = {
                    "id": record.get("id"),
                    "subject": record.get("subject"),
                    "status": record.get("status"),
                    "updated_at": record.get("updated_at"),
                    "document": json.dumps(record, ensure_ascii=False, default=str),
                }
                rows.append(
                    {
                        key: (
                            json.dumps(value, ensure_ascii=False, default=str)
                            if isinstance(value, (dict, list))
                            else value
                        )
                        for key, value in row.items()
                    }
                )
            for start in range(0, len(rows), batch_size):
                yield pd.DataFrame(
                    rows[start : start + batch_size],
                    columns=["id", "subject", "status", "updated_at", "document"],
                    dtype=object,
                )
            next_url = (
                payload.get("links", {}).get("next")
                if payload.get("meta", {}).get("has_more")
                else None
            )
            if not next_url:
                break
            next_address = self.client.base_url.join(next_url)
            if (next_address.scheme, next_address.host, next_address.port) != (
                self.client.base_url.scheme,
                self.client.base_url.host,
                self.client.base_url.port,
            ):
                raise ValueError("Unexpected pagination origin")
            next_url = str(next_address)
            if next_url in seen_pages:
                raise ValueError("API repeated a pagination URL")
            seen_pages.add(next_url)
            path, params = (next_url, {})

Running and extending the example

Register the connector before the sync and commit each resource separately:

vortexify create connector zendesk-support
vortexify create sync zendesk-support/tickets

Edit the files, inspect vortexify status, and use the CLI guide to commit and configure them. Registration alone does not run extraction or deploy the connector.

Preview must run with a fresh connector and disposable state. The extraction implementation determines full/incremental behavior; merely setting a mode does not implement change capture. API/driver failures propagate unless explicitly handled in the code. Check source limits and single-record/response sizes as well as output batch size.

Sources and further reading

WooCommerce connector

WordPress commerce platform for products, orders, customers, and inventory.

Zenventory connector

Warehouse management for inventory, fulfillment, customers, and shipping workflows.

On this page

What this connector is forData and tables you can pullRelationships and extraction considerationsConnecting to ZendeskConnection settings used by the examplerequirements.inWorked example: sync ticketsConnection schema: config.jsonConnector: connector.pySync schema: syncs/tickets/config.jsonSync: syncs/tickets/sync.pyRunning and extending the exampleSources and further reading