External Request
Last updated
Last updated
With external requests, you can call APIs from other third parties or your own server to request data, submit data and etc.
In an Action step, find "External Request" in "Advance Actions" and click "Add your request" then start editing it:
choose a request type such as GET, POST, etc
paste your request URL / endpoint
adjust "URL parameters", "Headers", "Body" or "Authorization" section if needed. e.g. setup API key
click "Test" and area 5 will show in the "Response" section with a response code
click on "Response Headers" to expand the header for more details and the received data is in blue
choose which part of the data you need by clicking the circle on the left-side accordingly
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. You can create a new field here by typing in a field name and clicking it in the drop-down. Click the "Add" button to add to the mapping list
finally, the mapping shows in area 9. Add as many mapping as needed and click "Save".
Make sure you provide testing data for any one of the fields/variables in the settings before you use the Test button.
In the above screenshot, we can see that there is a URL parameter in the endpoint called "user_name". Remember to copy the endpoint down and provide a testing value.
Alternatively, you can use the URL Params sections for the same result.
Same as URL Params, put your key name first, then insert the variable and provide a testing value.
Alternatively, put the token in the Authorization section. It's going to be less error-prone (sometimes people just forgot the "Bear " 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.
To include a file itself in the parameters, use multipart/form-data:
x-www-for-urlencoded works just like 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, Body Content, paste or write your JSON first, when you insert a variable, the Test body content shows on the right side immediately. It's to specify a testing JSON value.
Click on 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 testing values.
Once you are ready, click on the Test button next to the URL endpoint or in the Response section.
Besides the tips about how to map data above, you might also want to save the values in the response header for later use. Simply expand the header, click on a value in the header and the JSON path to it shows automatically there.
