TypeScript SDK

TypeScript SDK

Official SDK with full TypeScript support.

Installation

$npm install @bookedin/sdk

Quick start

1import { BookedIn } from '@bookedin/sdk';
2
3const client = new BookedIn({ apiKey: process.env.BOOKEDIN_API_KEY });
4
5// Create a lead
6const lead = await client.leads.create({
7 firstName: 'John',
8 phoneNumber: '+15551234567'
9});
10
11// Send a message
12await client.execute({
13 agentId: 'agt_xxx',
14 leadId: lead.id,
15 channel: 'sms'
16});

Available methods

1// Agents
2client.agents.list()
3client.agents.create({ name, generalPrompt, objective })
4client.agents.get(agentId)
5client.agents.update(agentId, { ... })
6client.agents.delete(agentId)
7
8// Leads
9client.leads.list({ search, pipelineStage, limit })
10client.leads.create({ firstName, lastName, phoneNumber, email })
11client.leads.get(leadId)
12client.leads.update(leadId, { ... })
13client.leads.delete(leadId)
14
15// Execute
16client.execute({ agentId, leadId, channel, message })
17
18// Strategies
19client.strategies.list()
20client.strategies.create({ name, triggerType })
21client.strategies.execute(strategyId, { leadId })

Error handling

1import { BookedInError } from '@bookedin/sdk';
2
3try {
4 await client.leads.get('invalid');
5} catch (err) {
6 if (err instanceof BookedInError) {
7 console.error(err.status, err.message);
8 }
9}