V2NodesHTTP
HTTP
V2

HTTP

The HTTP node is for inbound HTTP handling inside a workflow.
It's used when you need a webhook or API endpoint, exposing request data such as headers, query values, body, and method to the workflow.
HttpReceive is the entry point and HttpRespond is the reply.

Revision History

0.0.0.3 - Initial release.
0.0.0.12 - Node name correction.

Setup Notes

An API key will need to be generated and provided to the HTTP caller to authorize their access.

Methods

HttpReceive

HttpReceive captures an incoming HTTP request and starts the Workflow from that request. It's used when you need a webhook or API endpoint, exposing request data such as headers, query values, body, and method to the workflow.

This is a Trigger method, this means:

  • it must be first step in a workflow.
  • there can only be one Trigger method in a workflow.
Parameter Type Notes
Method String The HTTP method for the route.
UriTemplate String The request path and query for the route.
Return Type Notes
Request Object Output from Query.

HttpRespond

This sends the HTTP response back to the caller later in the workflow. It is used to control what the client receives, such as the status code, headers, content type, and response body.

Parameter Type Notes
StatusCode Integer The HTTP status code to return.
Headers Object Headers to include in the HTTP response.
Body Stream The response body returned to the caller.

Usage Notes

  • HttpReceive is the first method in the workflow. It receives the Http call and gives the request to the workflow.

  • Once you have processed the request, you use HttpRespond to give a custom result to the original caller.

  • Once a valid workflow has been built with HttpReceive, saving the workflow creates the endpoint given in UriTemplate on the environment in your Flowgear site settings.
    For example:

  • If the environment is company-test.flowgear.net

  • And you make a workflow with HttpReceive where UriTemplate is /custom/account/create

  • The externally exposed endpoint would be https://company-test.flowgear.net/custom/account/create

  • Only requests using the previously generated API key would have access.