Platform SDK
Build on Backfill in TypeScript. Two flavors — extensions for behavior, connectors for data ingest.
The SDK is split into two surfaces:
- Extensions —
defineExtension(...). Hooks, jobs, API routes, custom entities, dashboard pages, UI tabs, action buttons. The default flavor; reach for it for anything that augments Backfill’s existing behavior. - Connectors —
defineConnector(...). Third-party data integrations with first-class support for streams, signed webhooks, and the canonical ingest pipeline. Reach for it when your job is bringing data in.
Both share the same file/folder layout, the same standard-library globals, and the same deploy lifecycle. A connector is just an extension with extra connector-shaped manifest entries.
If you’re new, start with Get started and the Quickstart, then read Concepts end-to-end.
- Get started
Install the CLI, scaffold an extension, and ship your first hook.
- Concepts
How extensions plug into Backfill — glossary, standard library, script types, events, and runtime.
- Extensions
Anatomy of an extension — the manifest, file layout, and one article per global and script type.
- Connectors
Build third-party data integrations with defineConnector — streams, webhooks, and connection setup.
- Guides
End-to-end walkthroughs for the most common extension shapes.