Convoup Developer Docs
The official developer documentation for the Convoup WhatsApp Cloud API SDK.
What is Convoup?
Convoup is a developer-first WhatsApp Business Operations Platform built on the Meta WhatsApp Cloud API. It provides a programmable REST API, a real-time team inbox, CRM, intent-aware automation, campaign management, and a full compliance layer - all under one organisation.
The Node.js SDK wraps the Convoup REST API into typed methods, so you can send WhatsApp template messages with a single function call instead of crafting raw HTTP requests.
What You Can Build
- OTP and verification messages - Send login codes and one-time passwords
- Invoice and billing notifications - Deliver PDFs and receipts with media headers
- Appointment reminders - Schedule and send time-sensitive reminders
- Dynamic content - Personalize messages with per-customer images, videos, and documents
- Bulk messaging - Send to thousands of customers with concurrency control
Developer Documentation
Quick Start
Get from zero to your first WhatsApp message in under 10 minutes.
Get startedAuthentication
API keys, WABA scoping, and security best practices.
Learn moreHow Templates Work
Template structure, placeholders, components, and the approval workflow.
Learn moreSDK Methods
Complete reference for sendOtp, sendInvoice, sendReminder, and sendTemplate.
ReferenceREST Endpoints
Raw HTTP API reference for all Convoup REST endpoints.
ReferenceError Codes
Typed error handling with ConvoupError and every error code explained.
Learn moreArchitecture Overview
Your App → Convoup SDK → Convoup API → Meta WhatsApp Cloud API → RecipientThe SDK handles authentication (API key in x-api-key header), JSON serialization, payload construction from template names and parameters, error parsing, and response unwrapping. You focus on what message to send and to whom.
Requirements
- Node.js 18 or later
- A Convoup account with at least one approved template
- An API key from the Convoup dashboard