REST API Call

Estimated reading: 3 minutes

A REST API Call component is the mechanism used to execute a specific request to an external service’s API using standard HTTP methods.

Functionality

The REST API Call functionality includes:

1. Execution: Running calls using standard HTTP methods:
a. GET – Retrieves data from a specified resource (read-only).
b. POST – Creates a new resource on the server (submits data).
c. PUT – Replaces an existing resource entirely with new data.
d. PATCH – Modifies a specific part of an existing resource.
e. DELETE – Removes the specified resource from the server.
f. HEAD – Requests the headers only for a resource, without the actual body data.
g. OPTIONS – Requests information about the communication options available for the target resource or server.

2. Configuration: Customizing the request by setting headers, authentication details, and defining the request body format according to the API’s specification.

3. Reliability: Implementing graceful handling for delays, retries, and error responses to ensure the automated process is robust.

4. Integration: Supporting various request and response formats to ensure smooth data exchange with subsequent activities in the workflow.

Parameters

Parameter	Description
Endpoint	The complete URL of the API endpoint to be called.
HTTP Method	The HTTP request method to use (e.g., GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS).
Headers	Key-value pairs of request headers in JSON format (e.g., {"Content-Type": "application/json"}).
Request Body Format	Defines the request body type: raw, form-data, x-www-form-urlencoded, or binary.
Raw Type	Applicable when Request Body Format is raw. Specifies the data type — text, json, html, xml, or javascript.
Query Parameters	Optional query parameters in JSON format to append to the request URL.
Expected Response Format	Defines the format of the expected response (e.g., JSON, XML, Text).
Auth Type	Authentication method to be used (e.g., None, Basic Auth, Bearer Token, API Key).
Token	Authentication token or key used when Auth Type requires it (e.g., Bearer token or API key).
Timeout	Maximum time (in seconds) to wait for the API response before timing out.
Delay Between Retries	Time interval (in seconds) to wait before retrying the API request upon failure.
Delay Before Execution	Delay (in seconds) to wait before executing the API call.
Delay After Execution	Delay (in seconds) to wait after executing the API call before moving to the next activity.
Continue on Error	Determines whether the workflow should proceed if the current activity encounters an error. Stop Workflow – Immediately halts the workflow execution when an error occurs. Continue – Skips the failed activity and proceeds with the next step in the workflow. Continue Using Error Output – Allows the workflow to continue while capturing the error details as part of the output. This mode enables advanced handling scenarios where the error message or code is required for downstream actions, logging, or conditional flows.

REST API Call

Functionality

Parameters

REST API Call

CONTENTS