HTTP Response (Activity)


  • Purpose: To construct and send an HTTP response back to a client that made a request to an "HTTP Endpoint" activity.

  • Functionality: When used in conjunction with "HTTP Endpoint", the "HTTP Response" activity allows the workflow to define the HTTP response that will be sent back to the client. You can configure:
    • Status Code: HTTP status code (e.g., 200 OK, 400 Bad Request, 500 Internal Server Error).
    • Headers: HTTP response headers to include in the response.
    • Body: Response body content, which can be configured with various content types (JSON, XML, text, etc.).

  • Use Cases:
    • Responding to API Requests: Defining the response structure and content for REST API endpoints created with "HTTP Endpoint".
    • Implementing Custom API Logic: Workflows can process requests received at an "HTTP Endpoint" and then use "HTTP Response" to send back processed data or results in a structured HTTP response.
    • Controlling HTTP Communication: Having fine-grained control over all aspects of the HTTP response sent by the workflow.

How to Use HTTP Activities:

1. Drag and drop an HTTP activity from the HTTP section onto your workflow canvas.


2. Configure the properties of the chosen activity:

  • For HTTP Endpoint: Define the URL path, allowed HTTP methods, and any input/output schema for the endpoint.
  • For HTTP File Response: Specify the file to send, content type, and configure response headers.
  • For HTTP Request and HTTP Request (flow): Configure the target URL, HTTP method, headers, body, authentication, and any advanced flow control or error handling settings.
  • For HTTP Response: Define the HTTP status code, response headers, and response body content.

3. Connect the HTTP activities within your workflow to integrate web service communication into your automated processes. For example, use "HTTP Request" to call an external API, process the response, and then use "Send Email" to notify a user. Or, use "HTTP Endpoint" and "HTTP Response" to create a simple API endpoint exposed by your workflow.


4. Save and activate your workflow. When triggered (either by an HTTP request to an "HTTP Endpoint" or by reaching an "HTTP Request" activity in the workflow flow), the HTTP activities will perform their respective HTTP communication tasks as configured.


Benefits of Using HTTP Section:
  • Web Service Integration: Enables seamless integration with a vast ecosystem of web services and APIs using the standard HTTP protocol.
  • API Creation: Allows you to expose your workflows as HTTP endpoints, effectively creating your own web APIs.
  • Automated Data Exchange: Facilitates automated data retrieval and exchange between workflows and external systems via HTTP.
  • Flexible HTTP Communication: Provides fine-grained control over all aspects of HTTP requests and responses, including methods, headers, bodies, and authentication.
  • Workflow Triggering via Web Requests: "HTTP Endpoint" allows external systems to initiate workflow executions by sending HTTP requests.

By utilizing the HTTP section activities, you can build powerful and versatile workflows that can interact with the web, integrate with external services, and expose their functionalities through HTTP-based APIs, extending the reach and capabilities of your workflow automation.

Previous Next