Developers · Zaploom

Build Powerful Integrations

JSON API endpoints with workspace API keys, plus HTTP request steps in automations, so your systems can send messages and react to conversations.

Start free trial View pricing

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. API keys are created inside the workspace under Settings → Developers.

Get Your API Key

API Reference Authentication Rate Limits Errors

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 agent-level access
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

Zaploom receives WhatsApp webhooks from Meta for inbound messages and delivery receipts. To notify your own systems, add an HTTP request step to an automation: it calls your URL when the automation runs.

Triggers: message received, keyword match, contact created
Outgoing webhook subscriptions are not available yet

HTTP request step

Configured in the automation builder

// Automation step: HTTP request
{
  "type": "http_request",
  "config": {
    "url": "https://your-app.example.com/zaploom-hook",
    "method": "POST"
  }
}

Docs quick reference

The essentials for calling the API today.

Authentication Guide

Workspace admins create keys in Settings → Developers. Send x-api-key: wp_... on every request. Keys act with agent permissions and can be revoked at any time; create a new key before revoking an old one.

Rate limits

Zaploom does not publish its own API rate limits yet. WhatsApp sending is subject to Meta's messaging limits for your number, and campaigns are sent in batches.

Errors

Errors return a standard HTTP status with JSON like { "error": "..." }. A failed WhatsApp send returns 502 with Meta's reason.

Start building on Zaploom today

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

Get Your API Key Request a demo