Message Response Webhook

​

How does it work?

​

Message response webhook flow diagram

​

How to configure a message response webhook?

1

Log in to Treble.ai

Log in to Treble.ai through the following URL:

https://app.treble.ai

2

Create a flow

Go to the “Conversations” section and click on the “Create Conversation” button. You can also configure a message read webhook in an existing flow. For this, go to the “Flows” section and click on the “Edit” button of your flow.

3

Add message blocks

Let’s add the first message block. Click on the “Add block” button. In this case, we will add a message template (HSM) previously created and approved by Meta. Then we will connect a simple message block with the HSM block. Here we will ask for the customer’s identification number.

4

Activate webhook and add endpoint

Now, let’s double-click on the arrow that comes out of the message block and connects to the response block. A text field will appear at the top. In this field, we will add the endpoint to which you want the HTTP request to be sent when this message is read.

5

Specify the variable to capture the response

It is necessary to specify the variable to capture the customer’s response. Let’s double-click on the question block where we are asking for the identification number. In the panel that appears on the left, let’s click on the “Save response as variable” option. Two fields will appear:

• “Response type”: Here you can choose the type of response you want to capture. In this case, we will choose “Number”.
• “Variable name”: Here you can add the name of the variable you want to save. In this case, we will add client_id.

The use of variables in Treble is a key concept for process automation. You can read more about them at:

Variables in Treble

Learn more about variables in Treble.

6

Save changes

For the webhook to be activated, you must save the changes. If you are in a new flow, click on the “Publish Conversation” button to save the flow. If you are in an existing flow, click on the “Save” button to save the changes.

Done! Now, when someone responds to your message, the webhook will be triggered and will send an HTTP request to your endpoint configured in Treble. The request body will contain information about the response event.

​

Advanced Tutorial - Response from your server

​

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:
   Copy

   Ask AI

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

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

​

Code Example

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.