REST API

Call REST API Endpoint

Calls an external REST API endpoint. It runs when all the input link points are active. If successful triggers defined output link point.

Calls a REST API endpoint. It runs when all the input link points are active. If successful triggers defined output link point.

Input link points

Input link points

​Title	​Title
Multi input	​​✔️
Multi output	​​❌

Input link points

Name	Type	Description
input	object	Input object of the node that will be used to specify REST API parameters.

Output link points

Name	Type	Description
output	object, list, or trigger	Response of the REST API call. The type of the output link point is defined while defining the parameters of this node.
errors	list	Errors occurred during node execution.

Parameters

Name	Type	Description
Output model type	optional	The response object model type.
REST API response model definition	required	The model definition of the REST API call response. Only applicable for nodes with object or list output link point.
HTTP method	required	The desired action to be performed on the REST API endpoint.
Endpoint	required	The URL of the called REST API resource.
Authentication	required	The authentication type of the REST API. Can be either no authentication, API Key, Bearer Token, or Basic Authentication.
API key name	optional	(If authentication is set as API Key) The name of the API key
API key value	optional	(If authentication is set as API Key) The API key value
Add to	optional	(If authentication is set as API Key) The location (header or query) to add the API key-value pair
Token	optional	(If authentication is set as Bearer Token) Bearer token value
Username	optional	(If authentication is set as Basic Authentication) Authentication username
Password	optional	(If authentication is set as Basic Authentication) Authentication password
Query parameters	optional	Set of parameters attached to the end of the endpoint URL to help define specific content or actions.
Headers	optional	Name-value pairs that are used to pass additional information with the HTTP request.
Body type	required	The REST API call request body type, how the body parameters of the request will be sent to the API endpoint.
FormData parameters	optional	Form data type request body parameters.
URL encoded parameters	optional	URL encoded type request body parameters.
JSON document	optional	Application JSON type request body document.
Error management	required	Error handler type of processing errors raised by this node, either automatically or manually.