HTTP Request Node
The HTTP Request node makes an HTTP request (for example a REST call to a service) to a server and then takes the response and sets it as the payload of the message to be processed through the flow.
General Settings
Interval: Frequency which the specified folder is scanned for newly arrived files. The server measures this interval from the end of the last watch cycle.
Type: The type of the request.
- GET (used for downloading data)
- POST (used for uploading with extra parameters)
- PUT (used for uploading data)
- DELETE (used for removing resources on external services)
URL: The URL call to make. The URL string must be URI-encoded (in a URI-encoded string a space is shown as %20).
Headers
Some APIs require HTTP calls to send particular headers along with requests, typically to provide additional metadata about the operation you are performing. You can set these up in the Headers tab. Enter any key-value pairs to send along with the HTTP request.
- To add more than one header, click on the "Add header" button.
- To remove unneeded headers click on the "-" next to the row you wish to remove.
Body
The Body tab allows you to specify the data you need to send with a request. You can send various different types of body data based on the needs of the HTTP request being made.
You will need to send body data with requests whenever you need to add or update structured data. For example, if you're sending a request to add a new customer to a database, you might include the customer details in JSON. Body options are only available for PUT or POST requests.
Send Payload: This option uses the current workflow message payload as the body for the HTTP request.
Note: If you're sending body data, make sure you have the correct headers selected to indicate the content type your API may need to process the received data correctly.
Authorization
The HTTP Request node supports basic authorization which involves sending a verified username and password with your request. In the request Authorization tab, select Basic Auth from the Type dropdown list and enter the user name and password required for the URL endpoint.
Response
The Response tab contains the status code validation settings for the node. These determine what responses are considered valid to continue processing through the flow. Any responses considered invalid will be passed to the workflow trouble handling.
Replace message payload with response: When checked the contents of the http request will completely replace the contents of the workflow message payload
Follow Redirects (3xx responses): HTTP requests that return 3XX Redirection status codes will be followed using the maximum number or redirects set.
Default: HTTP status codes less than 300 are considered successful. All other response codes will be processed through the flow trouble handling.
Custom: Specify the HTTP status codes that are considered valid responses. All other response codes will be processed through the flow error handling.
Advanced Settings
Timeout
Timeout in seconds: If no data is sent or received during an operation for the specified time, the connection will be retried.
Reconnection Settings
Maximum number of retries: Sets the maximum number of retry attempts before the server gives up.
Delay between failed attempts: Time to wait between retry attempts.
When reconnection attempts fail: Determines what to do once the retry limit has been reached:
- Continue - The workflow remains active and logs the connection issue and just continues processing the flow based on watch settings.
- Stop Workflow - Trouble handling is triggered to notify user using the settings they chose then the flow is stopped to prevent further files from being processed.