Docs Quickstart

Quickstart

Get from zero to a working Devloom integration in under 10 minutes.

Step 1 — Install

Install the Devloom SDK via npm or yarn:

# npm
npm install devloom

# yarn
yarn add devloom

# pnpm
pnpm add devloom

TypeScript types are included. No @types/devloom package needed.

Step 2 — Configure your API key

Grab your API key from the Devloom dashboard. Set it via environment variable (recommended) or pass it directly:

# .env
DEVLOOM_API_KEY=dlx_live_xxxxxxxxxxxxxxxxxxxx
// TypeScript / ES modules
import { dlx } from 'devloom';

// Reads DEVLOOM_API_KEY from process.env automatically
const client = dlx.client({
  connector: 'fieldvault-crm',
  auth: dlx.auth.oauth2()
});

Step 3 — Make your first query

Fetch records from a connected platform. Auto-pagination and retry are enabled by default:

// Fetch all opportunities, auto-paginating across cursor pages
const opportunities = await client
  .query<Opportunity[]>('opportunities')
  .filter({ status: 'open' })
  .autopage()
  .all();

console.log(`Fetched ${opportunities.length} records`);

Stream real-time events

Subscribe to webhooks with a normalized event schema:

const stream = await client
  .stream('opportunity.updated')
  .on('event', (event) => {
    console.log('Record changed:', event.record.id);
  });

// Clean up
stream.close();

Next steps