Skip to main content
Databite SDK

​
Welcome to Databite SDK

Databite helps you self-host a simple API server for connectors and connect to it from your frontend. You run a server with @databite/server, then use @databite/connect in your app to authenticate users and create connections.

​
Why Databite?

Server

Host a REST API that exposes connectors, integrations, connections, flows, and sync jobs

React Connect

Use a drop-in modal to authenticate and create connections from your app

Build Connectors

Fluent API to define custom connectors and integrations

Sync Engine

Optional scheduling and execution for sync jobs

​
Quick Start

Get up and running with Databite in minutes: 
# Install main packages
npm install @databite/server @databite/connect

# Optional (custom connectors, sync, types)
npm install @databite/build @databite/connectors @databite/engine @databite/types
1

Start your server

Create and run a Databite server that hosts connectors and integrations
2

Add integrations

Add built-in or custom connectors and create integrations on your server
3

Connect from your app

Use the React modal to authenticate and create connections via your server

​
Architecture

The Databite SDK follows a modular architecture with clear separation of concerns:
  • @databite/server - Express server with REST API
  • @databite/connect - React components for client integration
  • @databite/build - Fluent API to build connectors
  • @databite/connectors - Pre-built connectors
  • @databite/engine - Optional sync engine
  • @databite/types - Shared TypeScript types

​
Three-Tier Hierarchy

Databite uses a clear three-tier hierarchy for managing integrations:
  1. Connector - A template/blueprint that defines what properties and configurations are available
  2. Integration - An instance of a connector where specific values have been filled in
  3. Connection - When someone actually uses an integration to connect to a service

​
What’s Next?

Quickstart

Stand up a server and connect from your app in minutes

Server API

Explore server setup and API endpoints

Example Web App

See a working client that talks to your server