Build WhatsApp into your product
| 1 | curl -X POST https://api.convoup.com/v1/messages \ |
| 2 | -H "Authorization: Bearer YOUR_API_KEY" \ |
| 3 | -H "Content-Type: application/json" \ |
| 4 | -d '{ |
| 5 | "to": "+15550192834", |
| 6 | "type": "template", |
| 7 | "template": { |
| 8 | "name": "order_confirmation", |
| 9 | "language": { "code": "en_US" } |
| 10 | } |
| 11 | }' |
API Capabilities
RESTful Messaging API
Send template messages or free-form replies with JSON payload validation.
Real-Time Webhooks
Receive inbound messages, delivery status, and template events via POST callbacks.
HMAC-SHA256 Verification
Verify every webhook with signature headers for tamper-proof event delivery.
Idempotent Requests
Pass unique idempotency keys to prevent duplicate sends during network retries.
Full Feature List
RESTful Outbound Messaging (`POST /v1/messages`)
Programmatically dispatch Meta-approved WhatsApp template messages or free-form replies (inside 24h window) with JSON payload validation.
Real-Time Webhook Engine (`POST /webhooks/receive`)
Subscribe to inbound message events (`messages`), message status updates (`delivered`, `read`), and template status updates (`approved`, `rejected`).
HMAC Signature Verification
Verify every incoming webhook event using SHA-256 HMAC signature headers (`X-Convoup-Signature`) to guarantee authenticity.
Contact & Segment Synchronization (`GET /v1/contacts`)
Programmatically query, create, update, or tag contact CRM records and retrieve historical message audit logs.
Tenant-Scoped Security
Bearer token authorization scoped strictly to your workspace ID with automatic rate limiting following Meta Cloud API guidelines.
Idempotent Operations (`X-Idempotency-Key`)
Pass unique idempotency headers on POST requests to safely prevent duplicate outbound message dispatch during network retries.
Embedded Signup & WABA Disconnect Handlers
Receive automated notifications when WABA permissions change or when a customer revokes Embedded Signup access.
Audit Logging & Compliance
Query historical API activity logs for compliance verification and enterprise system audits.
Dedicated engineering support available for API onboarding via [email protected].
Convoup REST API proxies Meta Cloud API requests while maintaining tenant isolation. API rate limits mirror Meta WABA tiering rules.