Message Response Webhook

​

How does it work?

When a user responds to a message, we can configure a webhook to be triggered and send an HTTP request to your endpoint configured in Treble. This webhook is one of the most important ones for implementing complex use cases, such as process automation or integration with other applications.

For example, you can configure a webhook to capture a customer’s response when they are asked for their identification number. Treble will send an HTTP request to your endpoint configured in Treble with the customer’s response, which you can process in your application. Subsequently, you can even return information to the Treble conversation (flow) to display dynamic information obtained by your server, or route the conversation through another path.

​

Message response webhook flow diagram

In this example, the customer responds to a WhatsApp message with their identification number. Treble sends an HTTP request to your endpoint configured in Treble with the customer’s response containing the identification number. Your server processes it and returns information to Treble to continue the conversation.

​

How to configure a message response webhook?

​

Advanced Tutorial - Response from your server

In the previous step-by-step, we saw how to configure a message response webhook in Treble. Now, let’s see how to process the customer’s response on your server. For this, it is necessary that your server has a public endpoint to which the HTTP request can be sent.

​

Step by Step

1. Configure your server: Make sure your server is configured to receive HTTP requests. You can use a framework like Express in Node.js to facilitate this process.

2. Create an endpoint for the webhook: Define an endpoint on your server that can receive webhook requests.

3. Process the request: Extract the relevant information from the request and perform the necessary actions, such as verifying if the user exists.

4. Send a response to Treble: Return a response to Treble with the processed information, such as the user’s authentication status. The response must be a JSON with the following format:

   {
        "user_session_keys":[
            {
                "key":"server_user_valid",
                "value":"yes"
            }
        ]
    }

The user_session_keys is an array of objects that contains the key and value of the response. For this example, the key should be server_user_valid and the value should be yes if the user exists or no if they don’t. However, you can send back to Treble any information you need to continue the conversation. This response can contain more variables that can be used in the flow.

Example:

{
    "user_session_keys":[
        {
            "key":"user_name",
            "value":"John Smith"
        },
        {
            "key":"last_purchase_date",
            "value":"2025-01-01"
        }
    ]
}

​

Code Example

Here is a basic example of how you could implement this in Node.js:

const express = require('express');
const app = express();
app.use(express.json());

app.post('/webhook', (req, res) => {
    // Extract the user identification from the user_session_keys
    const identification = req.body.user_session_keys.find(key => key.key === 'client_id')?.value;

    // Simulate user verification
    const userExists = verifyUser(identification);

    // Prepare the response for Treble
    const server_resp = userExists ? 'yes' : 'no';

    // Send the response back to Treble with the correct structure
    res.json({
        user_session_keys: [
            {
                key: "server_user_valid",
                value: server_resp
            }
        ]
    });
});

function verifyUser(identification) {
    // Logic to verify if the user exists
    // Here you can query a database or an external service
    return identification === '12345'; // Example verification
}

app.listen(3000, () => {
    console.log('Server listening on port 3000');
});

5. Back in your conversation (flow) in Treble, we connect a conditions block to evaluate the server’s response. Note how the server_user_valid variable is a session variable that is saved in the flow and is the response that is sent to the server. The conditions block is an “If” type block and evaluates if the server_user_valid variable is equal to yes. If so, it continues along the authenticated user path. If not, it continues along another path.

​

Keep in mind

• You must configure the response webhook for each response (arrow ) that comes out of a message block. If you configure it on a single response or the first one, it will only be activated for the first response.

In the following image, you can see how you should configure the response webhook for each of the 3 responses that come out of a message block.