External Request - API

In an Action step, find "External Request" under "Advanced Actions" and click "Edit External Request" to start editing it:

• choose a request type such as GET, POST, etc.
• paste the URL/endpoint of your request
• adjust the "URL Params", "Headers", "Body" or "Authorization" section if needed — for example, to set up an API key
• click "Test" and area 5 will show in the "Response" section with a response code
• click "Response Headers" to expand the header and see more details; the received data appears in blue
• choose which part of the data you need by clicking the corresponding circle on the left-hand side
• after clicking area 6, the JSON path for the selected data is automatically shown here. $ means the whole JSON.
• choose which custom field to store the data in. You can create a new field here: type a field name and click it in the drop-down. Click the "Add" button to add it to the mapping list
• finally, the mapping is shown in area 9. Add as many mappings as needed and click "Save".

URL Params

In the screenshot above, we can see that there is a URL parameter in the endpoint called “user_name”. Remember to copy the endpoint down and provide a test value.

Alternatively, you can use the URL Params sections for the same result.

Headers

Just like in URL Params, put the key name first, then insert the variable and provide a test value.

Authorization

Alternatively, put the token in the Authorization section. It is less error-prone (sometimes people simply forget the “Bearer ” in front of the token).

Moreover, for Basic Auth, simply put your username and password value and the system will do the base64 encoding for you.

Body

To include a file in the parameters, use multipart/form-data:

x-www-for-urlencoded works exactly like the URL Params or Headers section.

Instead of listing all the payloads in x-www-form-urlencoded, you can also paste the example payload in raw JSON:

On the left-hand side, under Body Content, paste or write your JSON first; when you insert a variable, the test body content appears immediately on the right-hand side. It is used to specify a test JSON value.

Click Copy from body content to copy the whole JSON structure. All the variables will be replaced by {{ variable_name}}. Remove the placeholder and put your test values.

Testing

Once you are ready, click the Test button next to the URL endpoint or in the Response section.

Besides the tips about how to map data above, you can also save the response header values for later use. Simply expand the header and click a value: the corresponding JSON path appears there automatically.