Developers · Zaploom

Build Powerful Integrations

REST endpoints, typed SDKs, and reliable webhooks so your stack can send, sync, and react to every conversation.

Channels

WhatsAppSMS

Example request

curl -s https://zaploom.beenait.com/api/messages/send \
  -H "x-api-key: wp_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+15555550123",
    "channelId": "ch_abc123",
    "message": { "type": "text", "body": "Hello from Zaploom!" }
  }'

Developer resources

Jump to the topic you need — detailed docs ship inside the workspace under Settings → Developers.

Get Your API Key

API Reference Authentication Guide Rate Limits Error Codes Changelog

REST API

Predictable JSON over HTTPS

Send messages, manage contacts, templates, and campaigns via JSON API endpoints authenticated with workspace API keys.

API routes under /api/*
Workspace-scoped keys with tight RBAC
OpenAPI documentation coming soon

Create a message

Minimal POST body

POST /api/messages/send
x-api-key: wp_live_...
{
  "to": "+15555550123",
  "channelId": "ch_abc123",
  "message": { "type": "text", "body": "Your order shipped!" }
}

SDKs

SDKs coming soon

Official SDK libraries are in development. In the meantime, use the REST API with API key authentication to integrate with Zaploom programmatically.

Node.js quick install

ESM-friendly client

// SDK coming soon
// In the meantime, use the REST API with x-api-key header:

const res = await fetch("/api/messages/send", {
  method: "POST",
  headers: {
    "x-api-key": "wp_live_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    to: "+15555550123",
    channelId: "ch_abc123",
    message: { type: "text", body: "Hello!" },
  }),
});

Webhooks

Event-driven integrations

Subscribe to delivery receipts, inbound replies, flow completions, and automation checkpoints. Verify signatures with rotating secrets.

At-least-once delivery with dedupe keys
Replay recent events from the dashboard

Sample payload

Normalized envelope for automation triggers

// WhatsApp webhook payload (POST /api/webhooks/whatsapp)
{
  "object": "whatsapp_business_account",
  "entry": [{
    "changes": [{
      "value": {
        "messages": [{ "from": "15555550123", "type": "text" }]
      }
    }]
  }]
}

Sandbox

Safe experimentation

Mirror production schemas with isolated numbers, fixture contacts, and webhook tunnels for local development.

Throttled send quotas that mimic carrier behavior
Saved request collections for QA regressions
Switch environments with a single API key header

Environment header

Point traffic at sandbox routers

# Use API keys from Settings > API Keys
curl https://zaploom.beenait.com/api/auth/me \
  -H "x-api-key: wp_live_..."

# Webhook endpoints are configured per channel
# in Settings > Communication

Docs quick reference

Deep dives live in your workspace. These anchors mirror the sections our SDK users open most often.

Authentication Guide

Mint workspace keys from Settings → Developers. Send Authorization: Bearer <token> on every request; rotate keys without downtime using overlapping validity windows.

Rate limits

Separate buckets for burst sends, template approvals, and webhook deliveries. Campaign sends inherit priority queues so support traffic stays responsive.

Error codes

Errors return JSON with code, param, and retry hints. Map carrier-specific failures to stable Zaploom enums for logging.

Changelog

Breaking changes ship behind version prefixes with at least 90 days notice. Subscribe to developer emails in-product for webhook schema updates and new template categories.

Start building on Zaploom today

Launch unified messaging in days with templates, automation, and analytics included.

Get Your API Key Request a demo