On-Site Documentation

Endpoint Map

Reference for guarded public endpoints, portal configuration areas, and webhook event names.

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

Reference

Core Endpoint Operations

Public integrations should use guarded WhatsApp Gateway endpoints and customer portal configuration.

Public JSON API scope

POST /api/send-message is the public customer JSON API endpoint.
Customer webhook events are delivered to customer-configured destination URLs.
POST /integrations/3cx/webhook/{integration_id} is the 3CX integration webhook endpoint.

Dashboard form routes

These routes are managed through the authenticated customer dashboard and are not public JSON API endpoints: /api-keys, /instances/{id}/manage, and /integrations/3cx settings pages.

Operation	Default Method	Default Path	Notes
Health / Root	`GET`	`/`	Smoke test route to verify reachability and TLS.
Send Message	`POST`	`/api/send-message`	Guarded transactional API send endpoint. Requires Authorization: Bearer customer API key.
Manage Instance	`GET`	`/instances/{id}/manage`	Customer portal screen for connection, webhook, and responsible test sends.
Suppressed Recipients	`GET`	`/suppressed-recipients`	Customer portal view for opt-outs and manual suppression.
Acceptable Use	`GET`	`/acceptable-use`	Responsible messaging policy for allowed and prohibited use.

Customer Integration Areas

Safe Customer Configuration

Use these customer-facing areas to connect your systems with WhatsApp Gateway.

API keys let your CRM, ERP, website, or app send WhatsApp messages through WhatsApp Gateway.

Customer webhooks forward selected WhatsApp events to your CRM, ERP, n8n, Make, or custom application.

WhatsApp Gateway manages the internal connection to the messaging provider automatically. Customers only configure the events they want WhatsApp Gateway to forward to their own systems.

Area	Group	Path	Purpose
API Keys	Customer Access	`/api-keys`	Create keys for your CRM, ERP, website, or app.
Send Message API	Messaging	`/api/send-message`	Send guarded support, transactional, or operational WhatsApp messages.
Customer Webhooks	Events	`/instances/{id}/manage?tab=webhook`	Forward selected WhatsApp events to your own system.
Inbound Logs	Visibility	`/inbound-logs`	Confirm WhatsApp messages received by connected numbers.
3CX Integration	Integrations	`/integrations/3cx`	Connect 3CX to WhatsApp Gateway using controlled middleware.
Responsible Messaging	Safety	`/docs/responsible-messaging`	Understand allowed purposes, limits, opt-outs, and policy controls.

Events

Supported Webhook Events

Recommended Events

message.received
message.sent
message.failed
recipient.opted_out

Instance Events

instance.connected
instance.disconnected
instance.connection_updated
instance.qr_updated

Message Lifecycle Events

message.delivered
message.read
message.status_updated

Conversation Events

conversation.updated

Call Events

call.received
call.missed

Group Events

group.message_received
group.updated