Browse our comprehensive FAQ section to quickly find solutions, learn how to use ChatMaxima features, and get step-by-step guidance for setup, integrations, and support.
The webhook block allows your chatbot to receive real-time data from an external service or application. This is essential for triggering a bot's actions based on events that happen outside of the chat.
You can select how the data is handled in the "Select Webhook Type" field. A Conversational webhook is used when the data will be used for a direct reply to the user. A Workflow webhook is used for automation tasks that don't require an immediate reply to the user.
The Webhook URL is a unique and secure web address where your external service will send data to trigger your bot. The URL is automatically generated for you.
The Authorization Token is an auto-generated security key that ensures only authorized external systems can send data to your webhook. It protects your bot from unwanted requests.
Webhook functionality requires the bot to be connected to at least one account because the webhook needs a way to send a reply or perform an action on a specific channel (like WhatsApp or Livechat) if needed.
If the bot is not connected to a channel, an alert will be displayed directing you to the Channels page to set up an account and link it to the bot.
You select the channel in the "Select Channel" field, which lists all channels with active bot integration. Then, you choose the specific account linked to that channel in the "Select Account" field to ensure accurate delivery.
You can use the "Save in variables" section to map the incoming data from the webhook to variables in your bot.
In the "Data" field, you specify the identifier for the data you want to capture (e.g., data.name), and in the "Set Variable" field, you choose a variable to store it in (e.g., customer_name).
The "Contact Reference ID" is a unique identifier used to reach the user. For WhatsApp, it's the mobile number with the country code. For other channels, you can use the contact ID or a system variable like {sys_contact_reference_id}.
They work together to create a mapping. The Data field identifies the incoming information from the external service, and the Set Variable field tells the bot what to name that information so it can be used in the conversation.
The block provides a "Sample Curl Request" for both "production" and "development" environments that you can copy and use to test your webhook.
The Production cURL request provides the basic, live configuration. The Development cURL request is pre-filled with specific channel and account aliases, making it easy to test the webhook in a non-live environment without affecting your live bot.
Authorization: Bearer header in a cURL request for a Webhook block mean?
This header is part of the request's security. It's how you send the auto-generated Authorization Token to authenticate with your webhook endpoint.
Content-type: application/json header in a cURL request for a Webhook block mean?
This header tells the webhook that the data being sent in the request body is in a JSON format.
After you have filled in all the necessary fields and set up your data mapping, you must click submit to save the block.
To connect your external service, you will need to copy the Webhook URL and the Authorization Token from the block and use them in your external application's settings.
You can find the webhook block by navigating to Dashboard → Quick Access. Then, under ChatMaxima Studio, click on Create Chatbot. The webhook block will be available in the sequence section of the builder.
To find a video tutorial for the webhook block, navigate to Dashboard → Resources. In the dropdown menu, click on Video Tutorial, and then use the search bar to find the specific guide.
Link: https://chatmaxima.com/video-tutorials/using-sequence-webhook-in-chatmaxima/
You can use a webhook to:
Trigger a welcome message when a user signs up on your website.
Send an alert to a bot when an order is received.
Initiate a chat with a user when they abandon their cart.