hub WhatsApp Gateway
Sign In View Docs

On-Site Documentation

WhatsApp Gateway Documentation

All core documentation now lives on this domain. Use the guide map below for setup, connection, sending, receiving, and troubleshooting.

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

Overview

What This Docs Portal Covers

Portal setup and direct API usage for controlled transactional send/receive operations.

Customer Setup Track

  • Connect a WhatsApp number from the customer dashboard.
  • Create API keys for your CRM, ERP, website, or app.
  • Configure customer webhooks to forward WhatsApp events to your system.
  • Use inbound logs to confirm received WhatsApp messages.
  • Review responsible messaging before enabling production usage.

Guarded API Integration Track

  • Send through the guarded app endpoint /api/send-message.
  • Use an instance provisioned from your app dashboard (instance creation is app-only).
  • Connect and manage session in your app instance manager.
  • Send outbound messages only for approved transactional and operational purposes.
  • Forward inbound and delivery events using customer webhooks.

Guides

Choose A Guide

Quickstart Step-by-step setup and initial checks. Connect Instance Create, connect, and confirm instance state. Send Messages Text/media send workflow and validation. Receive Webhooks Inbound events, webhook setup, and tests. Responsible Messaging Purpose values, limits, errors, and best practices. 3CX Overview Middleware setup, message flow, and controls. 3CX Webhooks Endpoint, headers, events, and examples. 3CX Call Events Templates, variables, cooldowns, and policy checks. 3CX Troubleshooting Common middleware errors and fixes. n8n Integration Webhook setup, events, templates, and troubleshooting. Endpoint Map Core and section endpoint references. OpenAPI Public API schema and import link. SDK Overview Examples and package roadmap. PHP Examples Send, errors, and webhook verification. Node.js Examples Fetch, Express, and signature checks. Python Examples Requests, Flask, and signature checks. Postman Collection Downloadable collection and variables. Troubleshooting Common failures and recovery checklist.

Recommended Reading Order

  • Start with Quickstart to validate API access.
  • Move to Connect Instance for QR pairing workflow.
  • Use Send Messages to validate outbound operations.
  • Finish with Receive Webhooks to complete inbound flow.
  • Review Responsible Messaging before enabling production send volume.

Scope And Intent

  • Documentation is intentionally hosted here without external doc redirects.
  • Examples are written for production-style integration validation.
  • Endpoint details focus on customer-safe API keys, webhooks, inbound logs, and responsible messaging controls.
  • Troubleshooting includes known errors from current deployment logs.
  • Acceptable use is documented at /acceptable-use.
Open Responsible Messaging