Incoming message webhooks deliver real-time notifications when your recipients reply, enabling immediate responses and interactive conversations through WhatsApp.
Overview
Webhooks are HTTP callbacks that deliver notifications to your server whenever specific events occur - in this case, when recipients reply to your WhatsApp messages. Benefits include:- Real-time processing of customer responses
- Seamless integration with your existing systems
- Automated workflows triggered by customer messages
- Enhanced customer experience through timely interactions
Try it in the API Reference
Explore the Webhook Management API and start receiving incoming messages
Webhook Configuration
Managing Endpoints
1
Access Webhook Settings
Navigate to the Developer section in your dashboard sidebar to manage webhook configurations.
2
Configure Endpoint
Add a new webhook URL where you want to receive incoming message notifications.
Endpoint Requirements
All webhook endpoints must be publicly accessible via HTTPS and configured to accept POST requests with JSON payloads. HTTP endpoints are not supported in production environments.
- Accept HTTP POST requests
- Process JSON payloads
- Return a 2xx status code within 10 seconds
- Implement idempotency handling (see best practices below)
Webhook Payload
When a user replies to your WhatsApp message, we’ll send a POST request to your configured endpoint with a detailed payload.Sample Payload
Payload Fields
Array containing the recent messages in the conversation
Human-readable summary of the recent conversation
The phone number of the recipient who sent the message
The name of the recipient if available
Unique identifier for the user in your system
The last message sent by the user
The last message sent by your system
The type of the latest message (text, image, audio, video, document, location)
Unix timestamp of the user’s last message
Unix timestamp of your system’s last message
URL to media file if the latest message contains media (null for text messages)
Custom note field for additional context
Automation-related notes
Comma-separated labels for categorizing the conversation
Webhook Management API
You can programmatically manage your webhook endpoints using our API.Create Webhook Endpoint
Register a new webhook endpoint to receive incoming message notifications.Always verify webhook signatures to ensure the authenticity of incoming requests. This prevents malicious actors from sending fraudulent events to your endpoint.
Troubleshooting
Webhook Not Receiving Events
Webhook Not Receiving Events
- Verify your endpoint is publicly accessible
- Check for HTTP 4xx or 5xx responses
- Ensure proper SSL certificate configuration
- Verify your webhook is enabled in the dashboard
FAQs
Can I receive notifications for all WhatsApp account events?
Can I receive notifications for all WhatsApp account events?
Currently, webhooks are available for incoming messages only. We’re working on expanding support for additional event types like delivery receipts, read receipts, and account status changes.
How do I handle different message types?
How do I handle different message types?
Check the
message_type
field in the webhook payload to determine the message type (text, image, audio, video, document, location) and process accordingly.Do I need to respond to every webhook request?
Do I need to respond to every webhook request?
Yes, your endpoint must respond with a 2xx HTTP status code for every webhook request to acknowledge receipt. This prevents unnecessary retries.
How can I test webhook delivery?
How can I test webhook delivery?
Use the “Test Webhook” feature in the Developer section of your dashboard to send a sample webhook payload to your endpoint.
Need assistance?
Our technical support team is available to assist with webhook configuration, payload handling, and integration questions.