@beepsdev/sdk

@beepsdev/sdk

TypeScript SDK for the beeps.dev API.

Sign up at beeps.dev

• Documentation: Full documentation site

Install

pnpm add @beepsdev/sdk

Basic Usage

import { BeepsClient } from "@beepsdev/sdk";

const beeps = new BeepsClient({
  apiKey: process.env.BEEPS_API_KEY!
});

const relay = await beeps.relay.create({
  name: "mycompany primary on-call relay",
  description: "this is our primary rotation",
  externalKey: "mycompany::relay::primary"
});

Members

List organization members to resolve emails to user IDs for schedule management.

const members = await beeps.member.list();

Errors

By default methods throw typed errors (AuthError, ValidationError, NotFoundError, RateLimitError, ServerError, NetworkError, HttpError). Use the safe variants to avoid try/catch:

const { data, error } = await beeps.relay.createSafe({...});

ValidationError includes a human-readable message and may include structured field-level issues on error.details:

import { ValidationError } from "@beepsdev/sdk";

try {
  await beeps.relay.rules.create("rly_123", {
    name: "Notify on-call engineer",
    ruleType: "schedule_notify",
    config: {
      schduleId: "sch_primary",
    },
  });
} catch (error) {
  if (error instanceof ValidationError) {
    console.error(error.message);
    console.error(error.details?.issues);
    console.error(error.requestId);
  }
}