DocsGetting Started

Overview & Introduction

Welcome to the PingStack Developer Platform. Integrate WhatsApp Cloud API messaging with your CRM, billing, and backend applications.

4 min readAPI v1

Welcome to PingStack Developer API

PingStack is an enterprise-grade WhatsApp Business platform built on the direct Meta WhatsApp Cloud API with 0% message markup. The PingStack REST API enables developers to programmatically dispatch template notifications, synchronize contacts, organize audiences, trigger broadcast campaigns, and subscribe to real-time outbound webhooks with built-in idempotency, rate limiting, and failure isolation.

PingStack & Meta WhatsApp Architecture

Understanding the architectural pipeline ensures seamless integration: ``` Your Application │ (HTTPS Bearer Token) ▼ PingStack Developer API (/api/v1/...) │ (Quota validation, phone normalization, idempotency caching, Redis BullMQ queues) ▼ PingStack Background Workers │ (Rate smoothing, circuit-breakers, retry policies) ▼ Meta WhatsApp Cloud API │ (Telco routing, template validation, policy enforcement) ▼ Recipient WhatsApp Device ``` * **PingStack Responsibilities**: Authentication, tenant isolation, request logging, idempotent dispatch, queue management, retry orchestration, and outbound webhook delivery. * **Meta Responsibilities**: Message template approvals, telco carrier message routing, 24-hour customer service window enforcement, and end-user handset delivery.

Base URL & API Versioning

All API requests must be made over HTTPS. The current version of the PingStack Developer API is **v1**. All endpoints reside under the `/api/v1` namespace.
https://app.pingstack.in/api/v1

Standard JSON Response Envelope

Every response returned by the PingStack API follows a standard, predictable JSON structure containing a `success` flag, a `request_id` for tracing, and either `data` or an `error` object.
{
  "success": true,
  "data": {
    "message_id": "8b9e6722-1d54-4a2e-b6a1-cb9e4f509d2a",
    "recipient": "919876543210",
    "status": "queued"
  },
  "request_id": "req_7f2b9a1c0d3e"
}