ClientPad SDK

TypeScript SDK for ClientPad's public API.

Install

pnpm add @clientpad/sdk

Basic Usage

Expose APIs with @clientpad/server, then consume them with this SDK.

import { ClientPad } from "@clientpad/sdk";

const clientpad = new ClientPad({
  baseUrl: "https://example.com/api/public/v1",
  apiKey: process.env.CLIENTPAD_API_KEY!,
});

await clientpad.leads.create({
  name: "Ada Customer",
  phone: "08031234567",
  source: "WhatsApp",
});

WhatsApp Inbox

The whatsapp resource manages live owner approval workflows.

// List conversations
const conversations = await clientpad.whatsapp.list({ status: "open" });

// Get chronological thread
const messages = await clientpad.whatsapp.messages(conversations.data[0].id);

// Fetch AI-suggested replies
const suggestions = await clientpad.whatsapp.suggestions(conversations.data[0].id);

// Approve and send an AI suggestion
await clientpad.whatsapp.approveSuggestion(conversations.data[0].id, {
  suggestion_index: 0,
  send: true,
});

// Send a manual reply and move pipeline stage
await clientpad.whatsapp.reply(conversations.data[0].id, {
  message_text: "Checking availability now.",
  send: true,
  pipeline_stage: "in_progress",
});

Upsert Leads

await clientpad.leads.upsert({
  name: "Ada Customer",
  phone: "08031234567",
  source: "WhatsApp",
});

leads.upsert requires the public API /leads/upsert endpoint and matches records by (workspace_id, phone).

Node

const leads = await clientpad.leads.list({
  limit: 50,
  offset: 0,
  status: "new",
});

Next.js Route Handler

import { ClientPad } from "@clientpad/sdk";

const clientpad = new ClientPad({
  baseUrl: process.env.CLIENTPAD_API_URL!,
  apiKey: process.env.CLIENTPAD_API_KEY!,
});

export async function POST() {
  const result = await clientpad.clients.create({
    business_name: "Ada Ventures",
    primary_contact: "Ada Customer",
  });

  return Response.json(result);
}

Express

app.post("/lead", async (_req, res, next) => {
  try {
    const result = await clientpad.leads.create({
      name: "Ada Customer",
      phone: "08031234567",
    });
    res.json(result);
  } catch (error) {
    next(error);
  }
});

Usage

Hosted ClientPad Cloud keys can expose quota and rate-limit usage:

const usage = await clientpad.usage.retrieve();

console.log(usage.data.request_count);
console.log(usage.data.remaining_requests);

Error Handling

import { ClientPadError } from "@clientpad/sdk";

try {
  await clientpad.leads.list();
} catch (error) {
  if (error instanceof ClientPadError) {
    console.error(error.status, error.payload);
  }
}

Custom Fetch

const clientpad = new ClientPad({
  baseUrl: "https://example.com/api/public/v1",
  apiKey: "cp_test_...",
  fetch: customFetch,
});