The API step in the Flow Builder allows you to make API calls defined in JSON format (XML is not supported).
Components of an API Call
An API call in the Flow Builder is composed of the following elements:
Component | Description |
|---|---|
HTTP Method | Specifies the type of action to be performed on the resource. Supported methods: GET, POST, PUT, DELETE, PATCH. |
URL | The endpoint address of the API being accessed. |
Headers | Additional information sent with the request, such as authentication or content type. Headers are key-value pairs, with values always treated as strings. |
Body | The data sent with the request, formatted in JSON. |
Saving API Response Data
You can store parts or the entirety of the API response (in JSON format) into variables. This is done using a JMESPath query, which extracts and manipulates the data from the JSON response.
JMESPath Overview:
JMESPath is a query language used to navigate and extract data from JSON. For more details, visit the official specifications and tutorial.
Setting up a JMESPath Query:
Use the JMESPath tab of the Parsing Helper.
Paste an example of the API response in the “JMESpath value” field.
JSON**Example Response** { "data": { "places": [ { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }, { "label": "Paris Orly", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "ORY", "parent": "PAR", "type": "airport" }, { "label": "Paris Roissy/Charles de Gaulle", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "CDG", "parent": "PAR", "type": "airport" }, { "label": "Paris - Beauvais", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "BVA", "parent": "PAR", "type": "airport" }, { "label": "Paris Vatry", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "XCR", "parent": "PAR", "type": "airport" } ] } }Enter the JMESPath query in the “Template” field.
Example Query:
data.places[0]
Click “Submit” to verify that the “Render” value is what you expect to save in a variable.
JSON**Example Render { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }**
☁️ The Flow Builder API step does not support custom JMESPath filters such as approx, remove_accents, belongs_to, replace, replace_all, unique, and remove_duplicates.