HTTP Response Node
The HTTP Response Node is used create a response to send back to the source of the HTTP request. Responses can be customized so that different status codes can be returned based on the outcome of the processed flow.
General Settings
The response node has settings to return information based on whether or not the workflow process from the HTTP Listener node succeeded.
Success
A success response is returned if no errors occur during the processing of the payload from the start of the HTTP Listener node.
Status: a 3-digit integer result code of the attempt to understand and satisfy the request. Intended to be used by automated processes.
Reason: Value to return as the reason for the specified status code. Intended to give a short textual description of the set status code. Intended for the human user but can also be used for automated systems.
Body: Data that is to be sent with the response. Can be set as one of the following:
- Payload - attaches the current workflow payload to the HTTP response
- Custom - Allows you to set custom formatted data as the body of the response. Workflow variables can also be inserted for more dynamic response data.
- None - sends an empty body with the HTTP response
Headers
The response-header fields allow the server to pass additional information about the response which cannot be placed in the Status or Reason line. These header fields can be used to provide information about the response or process that was completed if necessary.
Name: Header name to be sent with the response
Value: Key value to be sent with he specified header. Variables from the flow can be used if needed for dynamic header responses.
Error
If any error or problems occur in between the HTTP Listener the Response Node it will instead return the following separate message. This setup so that the client making the REST call can be correctly informed of any issues that occurred during the processing of the initial request.
Status: a 3-digit integer result code of the attempt to understand and satisfy the request. Intended to be used by automated processes.
Reason: Value to return as the reason for the specified status code. Intended to give a short textual description of the set status code. Intended for the human user but can also be used for automated systems.
Body: Data that is to be sent with the response. Can be set as one of the following:
- Payload - attaches the current workflow payload to the HTTP response
- Custom - Allows you to set custom formatted data as the body of the response. Workflow variables can also be inserted for more dynamic response data.
- None - sends an empty body with the HTTP response
Headers
The response-header fields allow the server to pass additional information about the response which cannot be placed in the Status or Reason line. These header fields can be used to provide information about the response or process that was completed if necessary.
Name: Header name to be sent with the response
Value: Key value to be sent witht he specified header. Variables from the flow can be used if needed for dynamic header responses.