HTTP CONNECTOR

Overview

The HTTP DELETE component allows sending HTTP DELETE requests to external services, enabling users to remove resources via API calls. It provides response details, including body, headers, and status code.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports DELETE Requests

   • The url must be a valid API endpoint accepting DELETE requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Optional Request Body

   • Some APIs accept a request body in DELETE requests.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Overview

The Dynamic Webhook component allows users to subscribe to a webhook URL, triggering the connector when a request is received at that URL. It can be used to listen for incoming HTTP requests and process their data in real time.

Usage

Features

• Automatically generates a webhook URL upon activation.

• Supports HTTP methods for subscribing (POST, PUT, GET, PATCH) and unsubscribing (DELETE, POST, PUT, GET, PATCH).

• Can capture request data, headers, query parameters, and method details.

• Allows configuring immediate response behavior.

Input Parameters

Output Parameters

Instructions

1. Configure Webhook Subscription

   • Provide the onStartRequestUrl and onStartRequestMethod to define how the webhook should be registered.

   • Set necessary headers and request body for subscription if required.

2. Listen for Incoming Requests

   • The webhook will trigger whenever a request is sent to the generated URL.

   • Captured request details (method, headers, body, query) will be forwarded to the output port.

3. Configure Webhook Unsubscription

   • Provide onStopRequestUrl and onStopRequestMethod to define how to remove the webhook upon stopping.

   • Use runtime expressions to pass response data from the start request.

4. Immediate Response Option

   • Enable immediateResponse if you want to return an automatic response to incoming requests.

   • If disabled, use a Response component later in the flow.

Overview

The HTTP PATCH component allows sending HTTP PATCH requests to external services. It is typically used to partially update resources via API calls. The connector processes the request and returns the response details, including body, headers, and status code.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports PATCH Requests

   • The url must be a valid API endpoint accepting PATCH requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Request Body

   • Use the body parameter to define the data that needs to be updated.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Overview

The HTTP GET component allows sending HTTP GET requests to external services. It is useful for retrieving data from APIs and other web resources. The connector processes the request and returns the response details, including body, headers, and status code.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports GET Requests

   • The url must be a valid API endpoint accepting GET requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Query Parameters

   • Use the body parameter to define query parameters as a JSON object.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Overview

The HTTP POST Component sends HTTP POST requests to external services. It supports both raw body and form-data submissions, making it suitable for various API interactions.

Usage

Input Parameters

Output Parameters

Notes

• Supports both raw and form-data body types.

• form-data mode allows file uploads along with other input types.

• Proper headers must be set for application/json or multipart/form-data depending on the request type.

Overview

The HTTP PUT Component sends HTTP PUT requests to external services. It is commonly used for updating or replacing resources via API calls.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports PUT Requests

   • The url must be a valid API endpoint accepting PUT requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Request Body

   • Use the body parameter to define the data being sent.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Notes

• PUT requests typically replace entire resources: Ensure that the provided data includes all necessary fields.

• Proper headers must be set: Use Content-Type: application/json for JSON payloads.

Overview

The Uptime Component periodically checks if a site is up or down. It sends a message when the site's availability status changes (i.e., the site goes from up to down or vice versa).

Usage

Input Parameters

Output Ports

Instructions

1. Set the Target URL

   • Provide a valid URL in the target field.

2. Monitoring Behavior

   • The component periodically checks the status of the target site.

   • If the site is down, it triggers the down port.

   • When the site comes back up, it triggers the up port with downtime duration details.

3. Ensure Proper Protocol

   • Only URLs with http:// or https:// are allowed.

Notes

• Status Codes Handling:

  • A 5xx response is considered a down status.

  • Successful responses indicate the site is up.

• State Persistence:

  • The component remembers the last known state of the site to detect status changes.

• Time Tracking:

  • When a site goes down, the downtime duration is recorded and sent once it comes back up.

Overview

The HTTP Response Component is used to return an HTTP response to a webhook. It allows setting a response body, status code, and headers, enabling proper interaction with external services that expect a structured HTTP response.

Usage

Input Parameters

Instructions

1. Set Response Body

   • Provide a valid JSON or string value as the response body.

2. Define Status Code

   • Choose an appropriate HTTP status code (e.g., 200 for success, 400 for client errors, 500 for server errors).

3. Specify Headers

   • Ensure proper content types (e.g., Content-Type: application/json) when sending structured data.

4. Ensure Valid JSON (If Required)

   • If Content-Type is application/json, the body should be a valid JSON object.

Notes

• Handles JSON Parsing: Automatically parses headers and body if they are provided as JSON strings.

• Error Handling:

  • If headers cannot be parsed, an error will be logged and the response will be canceled.

  • If Content-Type is application/json, but the body is invalid JSON, an error is thrown.

Overview

The Webhook Trigger Component fires when an HTTP request is received on a dynamically generated webhook URL. It allows external services to send data to this webhook, which then triggers a workflow in response.

Usage

Output Ports

Properties

Instructions

1. Retrieve Webhook URL

   • When the component is initialized, it generates a webhook URL.

   • Use this URL to receive HTTP requests from external sources.

2. Configure Immediate Response

   • Enable immediateResponse to automatically return the received data.

   • Disable immediateResponse to define a custom response later in the flow using the Response component.

3. Process Incoming Requests

   • When a request is received, it is sent to the request output port.

   • The data includes HTTP method, body, headers, and query parameters.

Notes

• Custom Responses: If immediateResponse is false, ensure a Response component is added to handle replies.

• Supports Any HTTP Method: Webhooks can receive GET, POST, PUT, DELETE, or any other HTTP method.

• Dynamic URL Generation: Each instance generates a unique webhook URL.