Connector SDK · self-service

Build the connector your business needs.

Bring any approved source into datahuts—from databases and SaaS applications to private APIs, files, and company-specific systems—through one secure, reviewable connector contract.

Download the starter Read the quickstart

Any approved source

One SDK, not one narrow connector type.

Developers implement the same governed lifecycle—test, discover, preview, validate, and publish—regardless of where the data lives.

Databases & warehouses

Connect SQL, NoSQL, cloud warehouses, and company-managed data stores.

SaaS & business apps

Add accounting, CRM, operations, support, HR, and vertical software.

ERP & private systems

Reach modern or legacy systems through the outbound-only private agent.

APIs & structured files

Turn approved REST, GraphQL, CSV, JSON, and scheduled exports into governed sources.

Quickstart

A small, reviewable adapter contract.

Start from the included example, connect it to synthetic data, then implement the three methods every datahuts connector shares.

1Copy a starter adapter and give the connector a stable manifest.
2Implement connection testing, discovery, and masked preview.
3Run the contract validator against synthetic data.
4Submit the manifest and validation report for review.
5Publish the approved connector to the shared registry.

adapter.tsTypeScript

import type { ConnectorAdapter } from '@datahuts/connector-sdk'

export const connector: ConnectorAdapter = {
  manifest: {
    id: 'acme-operations',
    name: 'Acme Operations',
    version: '0.1.0',
    access: 'read-only',
  },

  async test(context) {
    return context.client.healthCheck()
  },

  async discover(context) {
    return context.client.listReadableObjects()
  },

  async preview(context, request) {
    return context.client.previewRows(request.object, {
      limit: Math.min(request.limit, 25),
    })
  },
}

Publication gate

Every connector is reviewed before customers see it.

The SDK is open to new source types; the trust contract is intentionally strict.

Uses a dedicated read-only service account

Keeps credentials server-side or on the private agent

Blocks arbitrary writes and unrestricted query execution

Returns stable object, field, key, and relationship metadata

Masks sensitive preview values before returning them

Passes tenant-isolation, timeout, audit, and retry tests

Authentication & deployment

Use the right transport for the source.

HTTPS APIs and databases run with server-side credentials. Private systems run through a tenant-bound connector key and the outbound-only private agent. Credentials are entered only in the customer environment and are never included in a browser request, manifest, submission, or log.

1Sign in and open Dashboard → Developers → Connector Studio.
2For private sources, create a connector key for the agent ID.
3Store the one-time key and source credentials only in the runtime environment.
4Run test, discovery, preview masking, timeout, and tenant-isolation checks.

.envprivate agent

DATAHUTS_BASE_URL=https://datahuts.com
DATAHUTS_AGENT_ID=your-agent-id
DATAHUTS_AGENT_API_KEY=dh_agent_••••••••

# Source credentials stay here.
SOURCE_BASE_URL=https://source.example
SOURCE_READ_ONLY_TOKEN=••••••••

Submission & status

No email thread required.

Submit the manifest, repository URL, and validator output from Connector Studio. The submission receives an audit-backed review ID and remains visible in your dashboard. Shared publication is gated until the security and quality checks pass.

Manifest validated against the published JSON schema

Repository uses HTTPS and contains no source credentials

Synthetic test output attached to the submission

Submission status retained in the tenant audit ledger

Approved versions use semantic versioning

Breaking changes require a new major version and review

Build with datahuts

Your system can become the next trusted connector.

Download the starter, create your connector credentials, validate locally, and submit from Connector Studio. You can complete the standard path without contacting the datahuts team.

Open Connector Studio