HTTP Request
Call an outside API over HTTPS, fill it in with values from this conversation, and keep the answer for later steps and conditions.
Quick start
- Go to Automate → Workflows and open a workflow. Click + and pick HTTP Request.
- Pick GET or POST, whichever the API's instructions name. Type the Request URL, starting
https://. - Optional: add Headers, and on POST a JSON Body. Use
{{…}}in any of them. - Under Save response as, keep the default
http. Later steps then read the result as{{http.status}}. - Set Status to Published in the top toolbar, Save, confirm Publish. Agents: ask an owner or admin.
Watch out
- The host must be on Inchat's outbound allowed list before any call goes out. Ask support to add yours — there is no setting for it.
- A
{{…}}in a JSON body must sit inside quotes. The panel will not save it anywhere else; a body built elsewhere fails the step.



Details
Getting here
Automate → Workflows, open a workflow, click + on the canvas, then pick HTTP Request under Add Steps.
Before you start
- An owner, admin or agent can add this step and save the workflow. Only an owner or admin can publish it, and publishing is what makes it run on live conversations.
- Building and running workflows depends on your plan; see pricing.
- A public endpoint that answers over HTTPS on the standard port.
- That host has to be on Inchat's outbound allowed list, which is set for the whole platform rather than per workspace. File a ticket under Settings → Help & support to ask for a host to be added.
Set up
- Open the workflow and click + where the call belongs.
- Pick HTTP Request.
- Choose GET or POST, and set the Request URL. The Variable menu beside the box inserts a value from this conversation.
- Optional: add Headers as name and value pairs. On POST, write a JSON Body.
- Set Save response as to name where the answer lands. The default is
http. - Save the step. To publish: set Status to Published in the toolbar at the top of the editor, click Save, then confirm with Publish. The dropdown on its own changes nothing until you save.
Fields
- Method
- GET or POST.
- Default: POST
- Request URL
- The address to call. A
{{…}}here is filled in from this conversation before the call goes out. - Limits: Must start with
https://— checked when you save — and use the standard port, which is checked when the step runs. Every value put into it is encoded, so an answer can never send the call to a different host or a different path. - Headers
- Extra request headers, as name and value pairs. A
{{…}}in a value is filled in as plain text. - Limits: A value that ends up holding a line break, or another character a header cannot carry, fails the step before anything is sent. A Content-Type you set here is the one sent, however you capitalise it.
- Body (JSON · sent as application/json)
- What POST sends. Write it as JSON, and put each
{{…}}inside a JSON string, in quotes. - Limits: Shown only for POST. A GET sends no body at all, so anything written here is ignored. See Limits for what a
{{…}}outside a string does. - Save response as
- The name later steps use to read the answer. With the default,
{{http.status}}is the status code, and the JSON that came back sits under that name too. - Default: http
- Limits: Lowercase letters, digits and underscores, starting with a letter, up to 32 characters; the panel refuses anything else. Give a second call in the same workflow its own name, or it overwrites the first.
How it works
- What leaves Inchat is the method, the address, the headers and the body, with every
{{…}}filled in from this conversation first. - The values come from the same place a Send a Message step reads: the customer's answer, a contact field, the response an earlier call saved.
- Each part is protected for what it is. A value put into the address is encoded, so it stays one piece of the path or one query value.
- A value put into a JSON body is escaped, so a quote in a customer's answer cannot break the document or add a field of its own.
- A fixed
user-agentheader naming Inchat is attached too, unless Headers sets its ownuser-agent. - The call goes out the moment this step runs, and the workflow waits for the answer before moving on. It gives up after ten seconds.
- The answer is saved under the name you chose before the step is judged to have worked or failed. That is its status code, the JSON it returned under
.data, and the raw text under.text. - So a later step can branch on
http.okwhichever way this step went.{{http.status}}is filled only when the endpoint answered without a redirect. - A 404 or a 500 does not throw the answer away. The step is recorded as failed, and the next step can still tell the customer, in your own words, that the order was not found.
- A redirect is refused rather than followed. The address you give has to be the final one.
When it fails
- The address does not start with
https://: the panel refuses to save it. An address on a non-standard port saves, then fails when the step runs. - A
{{…}}in the address has no value: the step fails before anything is sent, naming the one that was empty. Give it a fallback —{{answer.text||none}}— when empty is a real answer. - The filled-in address has a path part that is only
.or.., such as/../: the step fails. A web client drops that part, so the call would go somewhere other than the address that was checked. - A header value holds a line break, or another character a header cannot carry: the step fails and nothing is sent.
- A
{{…}}in a JSON body sits outside a JSON string: the panel will not save it, and a body built another way fails the step. Put it in quotes. - The host is not on Inchat's outbound allowed list: the step fails before anything is sent. Getting a host added is a platform change — file a ticket under Settings → Help & support.
- The endpoint answers with a redirect, a 4xx or a 5xx, times out after ten seconds, or cannot be reached: the step is recorded as failed and the reason is on its line.
- A failed call does not stop the workflow. The next step still runs, and it can read whatever the answer put into the saved name.
- You read every one of these in the workflow's Activity tab: pick the run under Execution log, and the step's own line carries the reason.
Limits
- The allowed list of hosts is set for the whole platform, not per workspace. Until a host is on it, every call to that host fails before anything is sent.
- Whether a host is allowed is decided on the address after the values are filled in, because that is the address really called.
- Only GET and POST can be saved, from the panel and from Build with AI alike.
- A
$name is read as a variable in the body as well, because the Variable menu writes that spelling. A GraphQL variable named like one of Inchat's, such as$orderor$contact, is emptied. Rename it in your query. - The answer is kept up to 32 KB. If the endpoint says up front that it is sending more, nothing is kept at all.
- If it only goes over the limit part-way through, the text read so far is kept and the parsed JSON is not.
- It never retries. One call, once, when the step runs. A flaky endpoint needs a Wait and a second HTTP Request built into the workflow.
- It carries no sign-in of its own beyond what you put in Headers. There is no saved-credential picker the way Add Google Sheets Row has one.
- A redirect is always refused, even one to the same host.
Use cases
- Look up a courier's tracking status with the order number the customer just gave you, then read the status out of the answer and say it back.
- Post a notification to an outside system right after Move Deal to Stage marks a deal won.
FAQ and troubleshooting
- My step fails and says the placeholder has no value. What do I do?
- The address had a
{{…}}that came back empty. Sending it would drop part of the address, so the step stops instead. Either make sure the earlier step always fills it, or give it a fallback:{{answer.text||none}}. - Can a customer's answer send the call somewhere I did not intend?
- No, as long as your
{{…}}sits in the path or the query, not in the host. Every value put into the address is encoded first, so it stays one piece of the path or one query value. A slash, an@or a..in an answer cannot move the call to another path. - The API I want takes a form, not JSON. Does that work?
- Not from the panel. The Body box saves only JSON, so for an API that takes only a form, use a different endpoint or ask support.
- The step failed with a 404. Did the rest of my workflow stop?
- No. The step is recorded as failed and the next step runs, with the status and whatever came back already saved under your chosen name. Branch on
http.statusto answer the customer yourself.
Reading this with an AI assistant? Plain Markdown version.