Platform
Chatbot Builder Bulk Messaging Team Inbox Mini CRM API & Webhooks AI Integration WhatsApp Flows
Industries
E-commerce & D2C Real Estate Education Healthcare Finance & BFSI Logistics Hospitality Retail
Integrations 📚 Learn 📝 Blog 🗂 Codex Pricing Start Free Trial →
Connect  ›  The External API Request step
Foundation guide

The External API Request step, explained field by field

One step in the WA.Expert builder lets you connect WhatsApp to almost any service on the internet. Learn it once here, and every connection guide we publish becomes a five-minute job.

 Published 21 June 2026  8 min read  Sourced & dated  Linked by every connection guide

Most of what people want WhatsApp to do, fetch an order status, ask an AI a question, push a lead into a CRM, look something up in a Google Sheet, comes down to one thing: talking to another service's API. WA.Expert gives you a single step for that, the External API Request step, available in both the automation builder and the chatbot builder.

This page explains that step completely, field by field. It is the foundation for everything in our Connect section. Once you understand the seven fields here, every specific guide, connect to Gemini, connect to Razorpay, connect to Shopify, is just us telling you which values to type into which field. The concept never changes; only the values do.

 Why we teach the concept, not just the clicks

The interface of every service you connect to will change over time. Buttons move, pages get renamed, model versions get retired. What does not change is the shape of an API request: a method, a URL, authentication, and a body. Learn that shape once and you can connect to a service even after its setup screens have been redesigned. That is why this guide leads with the idea and links to each provider's live documentation for the parts that drift.

The step, at a glance

Here is the External API Request step as it appears in the builder. Every field is covered below, in the order you fill them in.

2. External API Request
×
Select Method
GET
Request URL
https://api.example.com/v1/resource
Select Auth Type
No Auth
Header Parameters
+ Add Header Parameters
Query Parameters
+ Add Query Parameters
Select Body Type
None
Choose Response Type
Default Response
SaveRun and Save

It looks like a lot of fields, but most requests use only three or four of them. A simple data lookup needs a method, a URL, and usually an authentication header. That is it.

Every field, in plain English

UID For Testing

A WhatsApp number you use to test the step while you build it. When you press Run and Save, WA.Expert runs the request as if this contact had triggered it, so you can see a real response before the automation goes live. It has no effect once the flow is running for real customers; it is purely a testing convenience.

Select Method

The kind of request you are making. The two you will use most are GET and POST.

MethodWhat it doesTypical use
GETReads data without changing anythingLook up an order, fetch a price, check stock
POSTSends data to create or trigger somethingAsk an AI a question, create a CRM lead, send to a sheet
PUT / PATCHUpdates an existing recordChange an order status, edit a contact
DELETERemoves a recordCancel a booking, delete an entry

The service's documentation states which method each of its endpoints expects. Use the one it specifies.

 Import cURL: the shortcut

Most API documentation gives you a ready-made example as a cURL command (a block starting with curl). The step has an Import cURL button: paste that command and WA.Expert fills in the method, URL, headers, and body for you automatically. When a provider's docs offer a cURL example, this is the fastest way to set the step up correctly.

Request URL

The web address of the specific endpoint you are calling. This is the single most important value, and it always comes straight from the service's API documentation. It usually looks like a normal URL with a path that names what you want, for example a path ending in /orders or /messages or /generateContent. Some services include a version such as /v1/ or /v1beta/ in the path; copy it exactly as the docs show, including the version.

Select Auth Type

How the service checks that you are allowed to call it. The step offers a few types; which one you pick depends entirely on what the service uses.

Auth typeWhat it meansWhere the key goes
No AuthThe endpoint is open, no key neededNothing to add (rare for real services)
API key in headerA secret key sent as a headerHeader Parameters, e.g. Authorization or x-api-key
API key in queryA secret key added to the URLQuery Parameters, e.g. key=YOUR_KEY
Bearer tokenA token sent as Authorization: BearerHeader Parameters

If you are unsure, the service's authentication docs will tell you. Header-based keys are more secure than query-based ones and are the modern default.

Header Parameters

Extra information attached to the request, added as name and value pairs. This is where authentication usually lives. The two you will meet constantly are the authentication header (carrying your API key) and Content-Type, which tells the service you are sending JSON. A typical pair looks like the name Content-Type with the value application/json.

Query Parameters

Values added to the end of the Request URL after a question mark, again as name and value pairs. Use them when the documentation asks for them, for filters, page numbers, or, on some older services, the API key itself. You can type them into the URL directly or add them here; adding them as parameters keeps the URL tidy and is easier to edit later.

Select Body Type

The data you send with the request, used mainly with POST. For most modern APIs this is JSON, a structured block of fields. Set the body type to JSON (raw) and paste the structure the documentation specifies, then replace the example values with your own data or with values pulled from your flow. A GET request usually has no body, so this stays as None.

Choose Response Type

How WA.Expert should interpret the reply. Default Response handles standard JSON, which covers nearly everything. After the step runs, you map fields out of that response, for example pulling the answer text out of an AI reply, or the status out of an order lookup, and use them in the next step of your flow.

The only four questions you ever need to answer

Every connection, to any service, comes down to finding four things in that service's documentation. Once you have them, filling in the step takes minutes.

1

What is the endpoint URL?

Find the specific endpoint in the docs for the thing you want to do. Copy the full URL, including any version like /v1/. This goes in Request URL.
2

What method does it use?

The docs state GET, POST, and so on for that endpoint. This goes in Select Method. A reading action is usually GET; an action that sends or creates something is usually POST.
3

How does it want authentication?

Look for the authentication or getting-started section. It will tell you whether the key goes in a header (and what the header is called) or in the URL as a query parameter. This sets your Auth Type and the header or query value.
4

What does it expect in the body?

For POST requests, the docs show the JSON structure to send. Copy it, set Body Type to JSON, and swap in your values. For GET requests there is usually no body.

 This is the whole skill

Connecting WhatsApp to a new service is never harder than answering those four questions from its documentation. Our guides do the finding for you: each one points to the exact doc section and gives you the values to paste. If a guide ever goes out of date because a provider moved something, these four questions are how you find the new location yourself.

A worked example: a simple GET lookup

Suppose a service lets you look up a postal code and returns the city and state. Its docs say: send a GET request to a URL ending in the postal code, no authentication needed. Here is how that maps onto the step.

2. External API Request
×
Select Method
GET
Request URL
https://api.postalpincode.in/pincode/400001
Select Auth Type
No Auth
Header Parameters
+ Add Header Parameters
Query Parameters
+ Add Query Parameters
Select Body Type
None
Choose Response Type
Default Response
SaveRun and Save

Method is GET because we are only reading. The Request URL is the endpoint with the pincode on the end. There is no authentication, so Auth Type stays No Auth and there are no headers. There is no body on a GET, so Body Type stays None. Response Type is Default Response, and from the reply we would map out the city and state to use in the next WhatsApp message. That is a complete, working connection with three fields filled in.

 Where to go next

Now that you know the step, pick a service from the Connect hub. Each guide gives you the exact method, URL, auth, and body for that service, plus a worked WhatsApp example and troubleshooting. The AI guides (starting with Gemini) are a good place to begin, since adding an AI reply to a chatbot is one of the most popular uses of this step.

Common questions

What is the External API Request step?
+
It is an action you add inside the WA.Expert automation builder or chatbot builder that makes an HTTP request to an outside service. You fill in the method, the request URL, the authentication, any headers or query parameters, and the body, and WA.Expert calls that service and hands the response back into your flow. It is how you connect WhatsApp to anything that has an API.
Do I need to know how to code to use it?
+
No, but you do need to read the documentation of the service you are connecting to. The step itself is just form fields. The skill is finding four things in the other service's docs: the request URL, the method, how it wants authentication, and what it expects in the body. Every connection guide we publish walks you through exactly those four things for a specific service.
What is the difference between a header and a query parameter?
+
A header carries information about the request, most often the authentication key, and is not visible in the URL. A query parameter is added to the end of the URL after a question mark and is visible. Many services accept the API key in a header (more secure) while some older ones expect it as a query parameter. The service's documentation tells you which it wants.
What does the Response Type setting do?
+
It tells WA.Expert how to read what the service sends back. Default Response works for standard JSON, which is what most APIs return. You then map fields from that response into your flow, for example pulling a price or a status out of the reply and using it in the next WhatsApp message.
When does an External API Request step cost money?
+
The step itself is an automation action. Inside a WA.Expert workflow there are no charges except for an official WhatsApp template step (an outgoing message) or an external-data action like this one. The outside service may have its own charges, for example an AI provider bills for tokens, but that is billed by them, not by WA.Expert.
Why does the request work when I test it but not live?
+
The most common reasons are an expired or restricted API key, a rate limit on the other service, or a value that was filled in during testing but is not being passed correctly from your flow at run time. Check the response the step returns, it almost always contains an error message from the service that names the problem.
Start connecting

Put this step to work

Connect hub

Every connection guide, organised by what you want to link up.

Browse all →

Connect Gemini AI

Add Google's AI to a chatbot, the full worked guide.

Read guide →

Automation builder

Where the External API Request step lives.

See the builder →

Build a chatbot

Use the step inside a chatbot flow.

Read guide →

WhatsApp API glossary

Endpoint, header, token and more, defined.

Open glossary →

Chatbot planning template

Plan the flow before you build it.

Open template →

One step. Almost any service. Connected.

Free trial, no credit card required. And if you ever get stuck, we are the only platform in India that answers you live on WhatsApp.

Start Free →Book Demo
1