Skip to main content
External Request lets a Flow call an HTTP API mid-conversation. Use it to look up orders, load options, create tickets, or sync CRM data — then continue the script with the result.

​
When to use it

  • Fetch account or order status for a contact
  • Load dynamic multiple-choice options from your backend
  • Create a row in your system when a lead qualifies
  • Validate a coupon or appointment slot before confirming
For platform event push to your server (flow completed, new message), see Webhooks. External Request is the opposite direction: the Flow pulls or posts during a run.

​
Build an External Request

1

Prepare the endpoint

Use HTTPS. Decide method (GET or POST), headers, and auth (API key, bearer token, etc.).
2

Add the block

In Flow Builder, add External Request. Set URL, method, and headers. Use {{field}} placeholders in query/body when you need contact data.
3

Map the response

Parse JSON paths into custom fields (for example save data.status → order_status).
4

Branch on success and failure

Add paths for HTTP success vs error/timeout. Never assume the API always returns 200.
5

Test with real payloads

Run Test Flow with sample contact fields and confirm mappings.

​
Response mapping example

Example API body:
To show the USD rate, map rates.USD → a custom field (for example usd_rate). You do not need to prefix JSONPath with x. — use the path as it appears in the response. Test the request, copy the JSON, and validate paths with a JSONPath finder. Another example for Dynamic choices:
Map data into the options custom field.

​
Special mapping paths

Branch on http_status_code with a Condition when you need custom error handling.

​
Two ways to show API data

  1. Map → custom fields → messages — best for third-party APIs you do not control.
  2. Dynamic content — your API returns ready-to-send messages / actions JSON that Fliqr AI delivers on every channel.

​
Design rules

Do not put long-lived secrets in message text. Prefer server-side auth headers configured in the block, and rotate keys if they leak.
  • Keep payloads small; store only fields you will use.
  • Set clear error messages for contacts when the API fails.
  • Prefer idempotent server endpoints for retries.
  • Log correlation IDs on your side for support debugging.

​
Next

Dynamic content

Return messages and actions from your API.

Extract JSON

Split JSON into multiple custom fields.

Dynamic choices

Turn API arrays into multiple-choice options.

Common errors

Fix External Request and delivery failures.