Skip to main content
An API Call gambit runs its request before it sends its own messages. The flow then moves on whether the request succeeded or failed, so a failure never strands the conversation.

​
When to use it

Use API Call to look something up or to hand something off: fetch an order status, create a ticket, post a lead to your own system. For work that needs logic rather than a request, use Custom Code. For a reusable integration with its own credentials, use a tool gambit instead.

​
The gambit and its editor

Every page in this section shows the same demo flow: Start, a Welcome message, the gambit this page covers, then End. The gambit sits third, selected, with its editor open on the right. The rest of the screen is dimmed. The editor opens on Configuration, which holds everything on this page. Below it sit a collapsed Messages section and the POST Action and Conditions switches. The gambit has a single Default branch. To branch on the outcome, turn on Conditions and test the call’s status, described below.

​
Request

A row with an empty key is not sent. Before the request goes out, every whitespace character in a header value, including a line break, becomes a normal space, and the value is trimmed. A value pasted with a non-breaking space, such as Bearer and a token, therefore still works.
Test sends a real request to the endpoint you typed. Point it at a test endpoint before you use a method that writes.

​
Delivery tracking

The Delivery tracking dropdown tells analytics what this call is for: Goals and how they are counted are covered in Goals.

​
Reading the response

The full response is captured automatically, so no mapping is needed to use a field. Reference it by drilling the path with the gambit’s own variable name:
  • The gambit’s own request lands under {{api.<variable>.…}}.
  • A request that runs as a POST Action lands under {{post.<variable>.…}}.
Both also expose .status, .ok, .error, and .raw. A condition on .ok is the usual way to branch on failure. Select Test once and the response fields become suggestions in the @ menu, with the field count shown in the editor. Without a sample you can still type any path by hand, and the editor marks it unverified.

​
Named aliases

Named aliases is optional. It gives a short name to a deep path, which you then reference as {{flow.<alias>}}. Each row maps a JSONPath to an alias, and Add Alias appends one.
You never need an alias to read a field. Aliases keep a long path readable where it is used many times.