## Who can use Webhook in Chatbot Builder?


:::info
Advanced Chatbot Builder are available in the Pro & Business Plan only. [Read more about our plans](https://wati.brainfish.ai/articles/wati-pricing-plans-Zw5lmatoqt)

:::

A Professional plan is required to use and deploy Webhooks in Chatbots.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/ee074686-d3c4-4863-9b30-34ce18f00c59/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=4d7d2edfe30c4225b399cfd00bbedd4c1991ce6f61a5c571585dc5bd9cbf6935&X-Amz-SignedHeaders=host&response-content-disposition=attachment " =307x307")

With a standard account, you would still be able to build chatbots with webhooks and save them successfully. However, using them as [Keyword Action](https://wati.brainfish.ai/articles/what-is-keyword-action-aF8WkNExCn) or [Default Action](https://wati.brainfish.ai/articles/what-and-how-to-add-a-default-action-ygZrCP1wVi) would require upgrading to a Pro plan.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/5d76485c-5a61-4c13-a3c1-09a9bc3d22b3/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=cf8b79231a499985f166fb55639b383f2f81522bf5e649494962c1e6cc50c402&X-Amz-SignedHeaders=host&response-content-disposition=attachment)

## What is a Webhook in Chatbot Builder

**Webhooks**: Webhooks are automated HTTP callback functions you can use to perform a GET or POST API request.

**Usage:** Simply drag and drop the webhook icon or when you extend the chatbot, select the webhook feature.

## Features


1. **URL & Method**

Choose a Request method (GET/POST) and enter your URL endpoint of the external API.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/a5d9e806-0b00-4018-987d-f37c68522693/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=7e66834ccb6ed5b27b7bd91d4440872eedff5db184d8d5baaf12516967513a01&X-Amz-SignedHeaders=host&response-content-disposition=attachment)

You can make your URL dynamic by inserting variables into the path using the variables button.

Example: URL ⟶ https://webhook-wa-testing.clare.ai/123456789?name={{name}}


2. **Customize Headers**

Headers in HTTP webhook requests are used to specify the purpose of the webhook or its content type.

It is optional to use headers, and it is by default turned off.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/16bd2a57-337c-4236-b9b0-07c46d9be36f/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=2ed77e76e3e2c6d613df8dae59a4191a494f2d0a8506daa550c93b8ee4e265e3&X-Amz-SignedHeaders=host&response-content-disposition=attachment)

Headers are set as key-value pairs. Example: key = Content-Type & value = application/json


3. **Customize the body**

The body of the webhook request is added here. This is also optional and set as off by default.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/740028a2-780b-40f2-8107-145ec6816396/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=6149308eb0758a985ab0b5b6dfc93ccffc66e91ce0b930d6ab19c7803c6a45a6&X-Amz-SignedHeaders=host&response-content-disposition=attachment)


:::warning
The Body must always be in JSON format.

:::


4. **Set your test variable**

Manually setting your test variables here.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/72ff41f0-0fcb-42d4-b5ac-e3b72d65ee41/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=706f877e16ab19e274f407b70361b1be6b80384061a1e6f44c05a5699d779696&X-Amz-SignedHeaders=host&response-content-disposition=attachment)


5. **Test the Request**

You can test the API request by clicking on the 'Test the request' button.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/a7ace9cd-114e-4fc2-bf1d-cc1f448a4a5a/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=55c67b4b801f1e846924799fd2f4475264ee6a2a64c22824f12fae981ffcacd2&X-Amz-SignedHeaders=host&response-content-disposition=attachment)


6. **Save Responses as Variables**

You can also save the response of a request into variables or custom attributes. If your API response is a JSON with key-value pair, you can store each of the values by passing the key name. For example, if you want to store*"result": "success"* from the above response:

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/edc1a216-6a4c-4542-b19b-7e50fffcfb2e/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=97c3f72bd661dd6e2dc0102f277a03bd23753ee9d494944ff01b3ea9ce827de6&X-Amz-SignedHeaders=host&response-content-disposition=attachment)

**Storing Response values that are Inside an Object:**

If you want to store the response value that is inside an object, you need to use the objectkey.keyname format.

Example: if you want to store the QuoteId, you have to use Result.QuoteId in the **"Entire response Body"** above

```json
{ 
    "Result": { 
        "QuoteId": "xxxxx", 
        "QuoteNumber": "xxxxxx", 
        "PolicyNumber": null, 
    }, 
    "MessageValidation": null, 
    "QuoteReferrals": null
}
```

**Storing Responses that are Inside an** **Array of the Object:**

If you want to store the response value that is inside an Array of an object, you need to use the `$.[0].objectkey.keyname[0].value` format

Example: if you want to store `current_status`, you have to use `$.[0].tracking_data.shipment_track[0].current_status` in the **"Entire response Body"** above

```json
[
    {
        "tracking_data": {
            "track_status":1,
            "shipment_track" : [
                {
                    "id":1278937320,
                    "current_status":"Delivered"
                }
            ]
        }
    }
]
```

**Response Routing**

You can use response routing to split your chatbot according to response status codes.

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/e9b84ea8-f19b-412c-9db6-68ed08ac65ce/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=6b39e795e7480fdeb8e7647382a34f2a17a19b0f9ad90e5edc1f5ee61984f1c1&X-Amz-SignedHeaders=host&response-content-disposition=attachment)

 ![](https://brainfish-storage-prod.s3.us-east-2.amazonaws.com/uploads/8ce9edeb-6728-4e9a-aea1-2080a897fd28/f4fa6e51-a42c-40b4-861d-dbd4994d9182/migrated?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAUPPN5IL3QLQZLDSU%2F20250509%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250509T021946Z&X-Amz-Expires=3000&X-Amz-Signature=f03012cca1fe2a59bd0fafa5dd68a180af5ed0d4431c3a102e35af63cc2ac428&X-Amz-SignedHeaders=host&response-content-disposition=attachment)

Advance chatbot builder: Webhook

Triggering the AI Support Agent (KnowBot) from a Chatbot flow

AI Support Agent (KnowBot)

AI Support Agent (KnowBot) advanced settings

​AI Support Agent (KnowBot)

Whatsapp Flows

Custom Attributes for Whatsapp Flows

How to create a Rule for keywords

How to create an automation rule?

Learn more about Triggers

Learn more about Actions in Rules

Learn more about Filters in Rules

How to Automatically Assign a Chat to the Last Assignee

Rule-based Automation

CTWA Feature Highlights on WATI

Crash course in CTWA - all you need to know to get started!

Are your CTWA ads giving you good conversions? Track this in Wati with 4 easy steps

Wati and Google CTM Ads

General FAQs: CTWA

Click To Whatsapp Ads

How to manage notifications and sound?

How to change language for WATI?

How to change my timezone in WATI?

Personalize your account

How to add team and assign user to team?

Detail Access Menu of each Roles

How to view, search and delete users?

How to force logout a specific user from all active sessions?

Manage your Users

How to add a single contact?

How to add attributes to a contact?

How to import contacts to Wati?

How can I edit a contact?

How do I remove contacts?

How do I search and sort contacts?

How to add an attribute in bulk to a list of contacts?

How to delete contact attribute in bulk?

Manage your Contacts

Introduction to Team Inbox Analytics

Overview section

Team Inbox scheduled report

Operator Performance chart

Analytics and Reporting

How to enable Catalog feature for your Wati WhatsApp API number

How to send Catalog messages via Keyword action

How to use Wati Chatbot builder to send Catalog Messages

What are sets & How to create sets in your catalog

How to trigger a reply message once the “View sent cart” catalog message is sent from customer

How to use Sync button for Catalog feature

How to collect customer order details from Catalog orders using Google sheets

Orders page to display Catalog orders

How to collect online payment for catalog orders using Razorpay payment gateway

How to enable Auto Checkout and collect payment for my Catalog order?

What are item variants in a catalog

How to add variants for items when Catalog created using Google Sheet

How to set up a checkout flow for catalog orders using Wati Chatbot builder

Mandatory fields & specifications required to be added to product items when creating catalog

Catalog

How Long until My Template is Approved?

How do I increase the expiry time of chats?

What is the difference between template message and session message?

What are actions in Template Messages Page?

What is a template message?

What are template formatting rules?

Template Category Guidelines

What is the max numbers of template message submission?

What are the supported languages for template update?

Could I attach a PDF or image into a template message?

How to avoid template message rejection?

How to add buttons with template messages?

How to export and import template messages from one environment to a new environment?

How do I check and add credit to send broadcast template message

How to create and submit template messages in WATI?

Are non-transactional messages allowed with WhatsApp Business APIs?

How to use interactive messages?

How to get Opt-in for WhatsApp Messaging?

Template Message Guidelines

How to add buttons to templates?

How to trigger a chatbot with template?

Troubleshoot template message rejection

How to create a carousel template

What are limited time offer templates?

Understanding Meta’s Latest Updates on Template Approval

Template Messages

What and how to add a Default Action?

Setting working hours

Default Action

What is a Reply Material?

How do I add a Reply Material?

How to use the Sequence feature?

Reply Material

What and how to access Chatbot Builder?

How to build a chatbot?

How to use Questions for Chatbot builder?

How to use Conditions for Chatbot Builder

Advance Chatbot Builder: Setup Subscribe or Unsubscribe

Advance chatbot builder: Setup Assign User / Assign Team

Advance Chatbot builder: Update Attribute

What features are available in advance chatbot builder

Advance Chatbot Builder: Template

How to collect data with Google sheets in Chatbots

Chatbot Builder: What is a node and how many types of node?

Export and Import of Chatbots

Advance Chatbot Builder: Time Delay

How to create list message & message with reply button?

Advanced Chatbot Builder: Trigger Chatbot

Why is my chatbot not working?

How to test a chatbot?

Automatic chat assignment (Round Robin assignment)

How to use Fallback Message

How to use Chatbot Timer?

How to build a Chatbot

Steps to trigger a chatbot in Wati

Chatbot

How do I add a Keyword Action?

What is Keyword Action?

Keyword Action

Routing

What is WATI Automation Feature?

How does WATI Automation Feature work?

How to make a Backward Chatbot?

Automation

Building your WATI chatbot

Tips to send personalized media content broadcast to each number

How to send message to someone who is not in the Contact List?

Is there a limit of broadcast messages?

How do I edit or delete a scheduled broadcast?

What is a Broadcast History?

Where can I see Broadcast Statistics?

How can I search and filter Broadcasts?

How to Troubleshoot Common Errors? 

How to allow users to Opt-Out or Unsubscribe from Broadcasts?

Messaging limit for Click-to-WhatsApp Ads (CTWA)

How to easily broadcast to a subset of your Shopify customers on Wati?

How can I send catalog messages?

How can I use coupon codes?

"Message Undeliverable" when sending template messages

How can I enable click tracking for my templates?

Why is Meta/Wati restricting my messages?

General FAQs: Broadcasts

Broadcast

How to add contact to Favorite?

How to add a tag to chat?

How to use quick replies/canned replies?

How to search and filter chats?

How to download chats from WATI?

What happens if someone you blocked messages you again?

WATI Account running Slow

Copy Conversation URL

Supported media types & sizes on WATI

Understanding Different Chat Statuses

Multi-channel Team Inbox

Phone number masking in Team Inbox

How to add custom parameters/attributes?

How to start a new Chat?

How to Transcribe Audio Messages (Beta)

Team Inbox

Export Chats from Wati

WATI and its Features

How to Use a Phone Number Previously Registered With WhatsApp Business

How to Update the Connected Phone Number and Business Portfolio

How to Connect Your WhatsApp Number to Wati

Getting Free WhatsApp Business Phone Numbers from Meta

How to Reconnect your Phone Number to Wati

Understanding Your WhatsApp Phone Number Connection Status

Migrating Your WhatsApp Business Account from Another BSP to Wati

Connecting Your WhatsApp Phone Number to Facebook and Instagram

Creating a QR Code for Your WhatsApp Number

Choosing the Right Phone Number for WhatsApp

Phone Number Guide: Everything You Need To Know

Manage Multiple WhatsApp Numbers in a Single Wati Account

Connect Your Number

How to Enable Two-Factor Authentication (2FA) in Wati

Is Wati GDPR (General Data Protection Regulation) Compliant?

Wati Security and Data Management

How to Check Known Issues on Wati

Privacy & Security

General FAQs: Marketing Messages Lite (MM Lite) 

What are the most frequent problems encountered in the Embedded Signup process?

How to create or send your First Broadcast

Prerequisites before you Get Started with Wati

How to Create your First Chatbot

Creating Your Wati Account

How to Change or Update your Display Name on Wati

Guidelines to Choose your Display Name

How to Set Up or Update Your WhatsApp Account Profile

How to Change Your Timezone in Wati

How to Change the Language in Wati

Managing Notifications and Sounds in Wati

How to Configure Auto replies and OOO messages

How to Create Your First Template Message

How to Add your First Contact

Introduction to the Team Inbox

Marketing Messages Lite (MM Lite): All you need to Know

Getting Started

Steps to Complete Facebook Business Verification

How to Raise an Appeal for Account Review

How to Apply for Official WhatsApp Business Account (Blue Tick Verification)

A Deep Dive into WhatsApp Manager: What You Should Know

How to Check WhatsApp Business Account (WABA) Status

WhatsApp Business Account (WABA): Everything You Need To Know

Get Verified by Facebook