On-Site Documentation

OpenAPI Specification

Import the public WhatsApp Gateway API contract into your API tools and SDK generators.

Download PDF Overview Quickstart Connect Instance Send Messages Receive Webhooks Responsible Messaging 3CX Overview 3CX Webhooks 3CX Call Events 3CX Troubleshooting n8n Integration Endpoint Map OpenAPI SDK Overview PHP Examples Node.js Examples Python Examples Postman Collection Troubleshooting

OpenAPI

OpenAPI Specification

OpenAPI v1 documents the public customer API surface for WhatsApp Gateway integrations.

Open /openapi.json

Included Scope

POST /api/send-message for guarded customer message sending.
Bearer API key authentication for customer systems calling WhatsApp Gateway.
Request, success, and error schemas for the public send API.
Reusable customer webhook event schemas and webhook signature descriptions.
3CX Middleware webhook schema in a separate integration section.

Excluded Scope

Dashboard routes, admin routes, customer form routes, internal inbound webhook routes, and provider implementation details are excluded from the public OpenAPI contract.

Import Into Postman

Use /openapi.json as an import source to create a collection for the public customer API.

Generate SDK Clients

Use the schema as a starting point for client generation, then apply your team's retry, logging, and secret-handling standards.

Review Schemas

Check request, response, webhook event, and error schemas before connecting production systems.

Authentication

API keys are created in the customer dashboard and used as Bearer tokens by customer systems calling WhatsApp Gateway.

Authorization: Bearer CUSTOMER_API_KEY