On-Site Documentation

Receive Messages And Events

Configure webhook delivery and process inbound events with a clear verification workflow.

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

Receive

Receive Workflow

WhatsApp Gateway receives inbound messages, records them in Inbound Logs, and can forward selected normalized events to your systems.

Receive Flow

WhatsApp User

Customer sends an expected message to your connected number.

WhatsApp Gateway

Authenticates the inbound route and normalizes the event.

Inbound Logs

Message details appear in customer-visible receiving logs.

Customer Webhook

Selected events forward to your CRM, n8n, Make, ERP, or app.

How Receiving Works

WhatsApp Gateway receives messages from the connected WhatsApp number.
Messages appear in Inbound Logs for customer visibility.
Optional customer webhooks forward selected events to CRM, ERP, n8n, Make, 3CX, or custom apps.
Customers select normalized event types such as message.received or recipient.opted_out.

Customer Webhook Setup

Create a POST endpoint in your app: https://your-app.example.com/webhooks/whatsapp-gateway.
Open Dashboard > Instances > Manage > Webhook.
Enter your destination URL and select the WhatsApp Gateway events to forward.
Return HTTP 200 quickly after validation and queue processing.

What Customers Configure

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.

{
    "destination_url": "https://your-app.example.com/webhooks/whatsapp-gateway",
    "events": [
        "message.received",
        "recipient.opted_out",
        "message.status_updated"
    ]
}

Customer Webhook Payload Example

{
    "event": "message.received",
    "instance_id": "inst_12345",
    "instance_name": "faisak-demo",
    "from": "+9665XXXXXXX",
    "message_text": "Inbound user text message",
    "message_type": "text",
    "external_message_id": "wamid.example",
    "timestamp": "2026-05-07T10:00:00Z"
}

Minimum processing: route by event, store the message id, and process events idempotently.

Opt-Out Detection Event

When a recipient sends an opt-out keyword, WhatsApp Gateway suppresses future non-essential messages and may emit this event.

{
    "event": "recipient.opted_out",
    "instance_id": "demo-support-line",
    "instance_name": "Demo Support Line",
    "from": "+9665XXXXXXX",
    "reason": "recipient_requested_stop",
    "message_text": "STOP",
    "timestamp": "2026-05-08T10:00:00Z"
}

Recommended Event Set

message.received for inbound WhatsApp messages.
message.sent for successful outbound sends.
message.failed for failed outbound sends.
recipient.opted_out for STOP and opt-out handling.

Failure Handling

On 4xx/5xx receiver responses, inspect app logs first.
Keep handler idempotent to handle retries safely.
Capture payloads to replay failed events after fix.
Use troubleshooting guide for timeout or SSL issues.

Open Troubleshooting