Webhook Notification Payload Examples

Example JSON Payloads for Message Handling

Received Messages (Incoming Payload Example)

This is an example of a JSON payload for a message received from a customer:

Copy to Clipboard

Note: A fromMe value of false indicates an incoming message.

Send Messages (Outgoing Payload Example)

Below is an example of a JSON payload for a message that you send to a customer:

Copy to Clipboard

Note: A `fromMe` value of `true` indicates an outgoing message.

Below is the PHP example of how received data

This is a simple example to save message data to text file

Copy to Clipboard

<?php

// Check if the request method is POST
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
    // Receive the JSON payload
    $jsonPayload = file_get_contents('php://input');
    
    // Initialize variables
    $id = '';
    $fromMe = '';
    $receiverId = '';
    $senderId = '';
    $senderName = '';
    $messageText = '';
    $messageTimestamp = '';

// Decode the JSON payload into an array
    $data = json_decode($jsonPayload, true); // Passing true to get an associative array
    
    // Check if data is an array and not empty, then access the properties of the first element
    if (is_array($data) && !empty($data)) {
        $id = $data[0]['Id'];
        $fromMe = $data[0]['fromMe'] ? 'true' : 'false';
        $receiverId = $data[0]['receiverId'];
        $senderId = $data[0]['senderId'];
        $senderName = $data[0]['senderName'];
        $messageText = $data[0]['messageText'];
        $messageTimestamp = $data[0]['messageTimestamp'];

// Echo the data for debugging purposes
        echo "Id: $id, fromMe: $fromMe, receiverId: $receiverId, senderId: $senderId, senderName: $senderName, messageText: $messageText, messageTimestamp: $messageTimestamp\n";
    } else {
        echo "Error: Payload is not in the expected format.\n";
    }

// Save the data to a file. Include all variables.
    $content = "Id: $id, fromMe: $fromMe, receiverId: $receiverId, senderId: $senderId, senderName: $senderName, messageText: $messageText, messageTimestamp: $messageTimestamp";
    file_put_contents('message.txt', $content);
    
    // Respond to the request indicating success
    echo 'Data received and saved successfully.';
} else {
    // Handle cases where the script is not accessed via a POST request
    http_response_code(405); // Method Not Allowed
    echo 'Invalid request method. This endpoint expects a POST request.';
}

Below is the PHP example of how received data and insert to database

This is a simple example query to create a table

Copy to Clipboard

This is a simple example to insert message data to database

Copy to Clipboard

<?php

// Database configuration
$host = 'your_database_host';
$dbname = 'your_database_name';
$username = 'your_database_username';
$password = 'your_database_password';

// DSN (Data Source Name) for PDO connection
$dsn = "mysql:host=$host;dbname=$dbname;charset=utf8mb4";

try {
    // Create a PDO instance as db connection
    $pdo = new PDO($dsn, $username, $password);
    // Set error mode to exception to catch errors
    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

// Check if the request method is POST
    if ($_SERVER['REQUEST_METHOD'] === 'POST') {
        // Receive the JSON payload
        $jsonPayload = file_get_contents('php://input');
        $data = json_decode($jsonPayload, true);

// Prepare SQL statement to insert data
        $sql = "INSERT INTO whatsapp_messages (from_me, message_id, receiver_id, sender_id, sender_name, message_text, message_timestamp) VALUES (:from_me, :message_id, :receiver_id, :sender_id, :sender_name, :message_text, :message_timestamp)";

// Check if data is an array and not empty
        if (is_array($data) && !empty($data)) {
            $stmt = $pdo->prepare($sql);

// Bind parameters and execute SQL statement for each item
            foreach ($data as $item) {
                $stmt->execute([
                    ':from_me' => $item['fromMe'],
                    ':message_id' => $item['Id'],
                    ':receiver_id' => $item['receiverId'],
                    ':sender_id' => $item['senderId'],
                    ':sender_name' => $item['senderName'],
                    ':message_text' => $item['messageText'],
                    ':message_timestamp' => $item['messageTimestamp'],
                ]);
            }

echo 'Data inserted successfully into database.';
        } else {
            echo "Error: Payload is not in the expected format.";
        }
    } else {
        // Handle cases where the script is not accessed via a POST request
        http_response_code(405);
        echo 'Invalid request method. This endpoint expects a POST request.';
    }
} catch (PDOException $e) {
    // Catch and display error message
    die("Error: " . $e->getMessage());
}

Now time to test your webhook endpoint

This is a simple example of curl to text your webhook endpoint Note: please replace the webhook URL before testing the webhook

Copy to Clipboard

Online REST & SOAP API Testing Tool

reqbin.com

Webhook Integration Confirmation and Next Steps

Congratulations! Your webhook has responded with a 200 OK status and has successfully saved the necessary data. You are now ready to proceed to the next step, which involves integrating your webhook with the Business Management System (BMS).

Please follow these instructions:

Share the finalized webhook URL with the BMS technical team.
Coordinate with the team members to have your webhook added to the system.

Important Notice: The webhook payload system is an advanced feature that is not included in the basic BMS subscription. To enable this functionality, please consult with our BMS support team for detailed pricing information and to activate the add-on service.

We look forward to enhancing your BMS experience with this webhook integration.

Click to WhatsApp

Developers

Webhook Notification Payload Examples

Example JSON Payloads for Message Handling

Received Messages (Incoming Payload Example)

Send Messages (Outgoing Payload Example)

Below is the PHP example of how received data

Below is the PHP example of how received data and insert to database

Now time to test your webhook endpoint

Online REST & SOAP API Testing Tool

Webhook Integration Confirmation and Next Steps

Please follow these instructions:

CHATBOTS

SERVICES

RESOURCES

FOR PARTNERS