Skip to main content
The official TypeScript SDK repository includes runnable .ts files that mirror the flows documented in this guide.

​
GitHub repository

All examples live in the examples/ folder: github.com/VZaps/vzaps-sdk-typescript The folder includes a small package.json that installs the published npm package (@vzaps/sdk) and tsx. See examples/README.md in the repository for the full file list.

​
What’s included

FileTopic
01-auth-and-list-instances.tsAuth and instance listing
02-create-instance.tsCreate instance
03-instance-subscription.tsBilling subscription
04-session-and-pairing.tsSession status, QR, and pairing code
05-configure-webhook.tsWebhook configuration
06-realtime-subscribe.tsRealtime WebSocket subscription
07-send-text-message.tsSend text message
08-send-media-and-interactive.tsMedia, buttons, and list
09-send-poll-reaction-and-chat-actions.tsPoll, reaction, and chat actions
10-queues.tsMessage and operation queues
11-typebot-and-chatwoot.tsTypeBot and Chatwoot
You do not need to clone the full SDK repository.
  1. Download only the examples/ folder using Download ZIP on GitHub, or run:
npx --yes degit VZaps/vzaps-sdk-typescript/examples vzaps-ts-examples
cd vzaps-ts-examples
  1. Install dependencies, edit constants in the file you want to run, and execute:
npm install
npx tsx 07-send-text-message.ts

​
Option B — sparse checkout

git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript
git sparse-checkout set examples
cd examples
npm install
npx tsx 07-send-text-message.ts

​
Option C — full repository clone

git clone https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript/examples
npm install
npx tsx 07-send-text-message.ts
When developing the SDK itself, build and link the local package first. See the repository README for contributor setup.

​
Next steps