API Request and Response

ComponentTypeDescription
imgAPI Request and Response๐Ÿ”€ actionsend an API request and wait for a response

The API Request and Response component allows you to send a request to an API, and then wait for a response from that API. The workflow is paused until the API response is received.

Setting up the request#

When entering the API Request and Response component, the first step is to set up the request that will be sent.

img

Request type#

Select the request type. You can choose from POST, GET, PATCH and PUT options.

Data type#

Select the data type for the request. Currently only JSON is supported.

note

Contact us via the in-platform chat if you require your request to be in another data type.

Endpoint URL#

Insert the endpoint URL for the API here.

Body#

Construct the body of the request here. You can insert placeholders inside the body as well.

important

If the value of the placeholder is a string (i.e. text) make sure you place quotation marks " " around the placeholder i.e "${placeholder}". This is not required if the value of the placeholder is a number or boolean.

img

warning

Ensure that the body of your request is correctly formatted. If it is not correctly formatted, you may be prevented from progressing in the set up, or the component may not work properly. Contact us if you need any assistance.

Custom headers#

Click add header to add and configure custom headers for the request.

img

Setting up the sample request#

You will now need to configure the sample request. This step is required to retrieve a sample response from the API, which will then be used to map out placeholders.

Note that this will be configured the same as for the request you have just set up. However, if you used any placeholders inside of the body, you must now substitute those placeholders with a sample value.

So while your original request body with placeholders looked like this:

img

The sample request body will need to be something like this:

img

Sending the sample request#

Now we will send a sample request to the API endpoint to get a sample response. Click Send Request to trigger the sample request.

img

Once a sample response has been received, you will automatically move onto the next step.

img

Response received#

You can inspect the response that was received from the API. If everything looks correct, click next to proceed. If something is wrong, then click back and try adjusting the sample request.

img

Set up placeholders#

Based on the sample response, potential placeholder values will be automatically mapped. You can then select or unselect those which you do not require. You can also change the label for the placeholders in the third column as well.

img

Click next once everything is mapped to proceed.

Finish#

You have now set up your API Request and Response component ๐ŸŽ‰. The final page is a summary of the request that will be made, and the placeholders that will be generated from the response.

img

You can now save and exit the component.