Quickstart
Create credentials, send a test message, and inspect its event.
1. Open your workspace
Open /app, select your organization and default project, and connect a simulator number. A simulator number cannot contact real WhatsApp recipients.
2. Create a scoped API key
Create a key with only the project, numbers and actions your integration needs. Copy it once and place it in a server-side environment variable. Never place API keys in client JavaScript, a public repository, or an agent prompt visible to end users.
export SQKII_BASE_URL="http://127.0.0.1:4000"
export SQKII_API_KEY="your-scoped-key"For a deployed environment, use the origin configured by your administrator, normally https://whatsapp.sqkii.land.
3. Install a client
The repository contains the TypeScript and Python SDKs. Until public package publication is complete, install them from the local workspace; do not assume an npm or PyPI package has been published.
pnpm --filter @sqkii/whatsapp --filter @sqkii/cli build
node packages/cli/dist/index.js numbersSee SDKs for client examples and API reference for the source contract.
4. Send and receive
Choose the simulator number and send a text message using the SDK or dashboard. Use a new idempotency key for each intentional send; reuse the same key when retrying that send. Inject a simulator inbound message from the dashboard, then inspect its event, provenance and route.
5. Connect your agent
Register a signed webhook receiver or run the CLI event watcher. On an eligible live inbound event, your agent may create a reply. Do not reply automatically to imported history, phone-app echoes, delivery statuses or passive events.
6. Move to a live number
Complete Embedded Signup, confirm asset access and inspect the connection state. Verify a real inbound and outbound exchange using an eligible recipient. An HTTP acceptance response means the send was accepted for processing; the delivered event is the delivery evidence.