Cavuno SDK

Build custom job boards and careers pages with Cavuno’s TypeScript SDK.

Use @cavuno/board to read board data and build jobs, search, accounts, applications, alerts, employer workflows, monetization, and SEO into your own frontend. Cavuno runs the backend; your application owns its routes, components, design, and deployment.

The package has zero runtime dependencies and runs in browsers, Node.js 20+, and Cloudflare Workers. Package imports are the recommended path because they include TypeScript declarations and support tree-shaking.

Install the SDK

npm
pnpm
Yarn
Bun
npm install @cavuno/board

Create a client and fetch jobs

Create one client for the board, then reuse it throughout your application. A pk_… publishable key identifies the board and is safe to include in frontend code.

ts
import { createBoardClient } from '@cavuno/board';
const board = createBoardClient({
board: 'pk_your_publishable_key',
});
const [context, jobs] = await Promise.all([
board.context(),
board.jobs.list({ limit: 20 }),
]);
console.log(context.name);
console.log(jobs.data);

The client connects to https://api.cavuno.com by default. If the key is invalid or revoked, the request throws a BoardApiError rather than returning an empty board.

Follow Install as package to verify a real board before adding framework code, or review every option under Installing.

Install via CDN

Static HTML, CMS templates, page builders, and tag managers can load the same SDK as a classic browser script. That build installs CavunoBoard as a global and downloads the complete browser-safe SDK in one file.

Use the CDN installation guide for the exact-version URL, integrity hash, CSP, storage, and compatibility requirements. If your project can install npm packages, keep using the package route above for types and tree-shaking.

Continue building

For a ready-made starting point, clone the MIT-licensed TanStack Start + shadcn/ui job board template.

Understand the boundary

Cavuno ownsYour application owns
Board data and feature configurationRoutes and page composition
Search, pagination, and API authorizationComponents and interaction design
Candidate and employer workflow rulesSession integration and redirect UX
Monetization and entitlement decisionsCheckout handoff and return pages
Canonical data for SEO artifactsRendering metadata, JSON-LD, and sitemaps
Typed errors and request IDsError messages, logging, and recovery UI

The SDK is not a frontend framework, component library, or hosting platform. It supplies typed job-board data and workflows while leaving the frontend under your control.

Reference and support