TypeScript SDK
TypeScript SDK
Official SDK with full TypeScript support.
Installation
$ npm install @bookedin/sdk
Quick start
1 import { BookedIn } from '@bookedin/sdk'; 2 3 const client = new BookedIn({ apiKey: process.env.BOOKEDIN_API_KEY }); 4 5 // Create a lead 6 const lead = await client.leads.create({ 7 firstName: 'John', 8 phoneNumber: '+15551234567' 9 }); 10 11 // Send a message 12 await client.execute({ 13 agentId: 'agt_xxx', 14 leadId: lead.id, 15 channel: 'sms' 16 });
Available methods
1 // Agents 2 client.agents.list() 3 client.agents.create({ name, generalPrompt, objective }) 4 client.agents.get(agentId) 5 client.agents.update(agentId, { ... }) 6 client.agents.delete(agentId) 7 8 // Leads 9 client.leads.list({ search, pipelineStage, limit }) 10 client.leads.create({ firstName, lastName, phoneNumber, email }) 11 client.leads.get(leadId) 12 client.leads.update(leadId, { ... }) 13 client.leads.delete(leadId) 14 15 // Execute 16 client.execute({ agentId, leadId, channel, message }) 17 18 // Strategies 19 client.strategies.list() 20 client.strategies.create({ name, triggerType }) 21 client.strategies.execute(strategyId, { leadId })
Error handling
1 import { BookedInError } from '@bookedin/sdk'; 2 3 try { 4 await client.leads.get('invalid'); 5 } catch (err) { 6 if (err instanceof BookedInError) { 7 console.error(err.status, err.message); 8 } 9 }