search

HTTP Request Action

The HTTP Request Action node is the Swiss-Army knife for integrating Helmut with third-party REST APIs. It can send HTTP requests to any REST-based system and returns the full response (status code, headers, and body) to the stream for further processing.

hashtag
Input Parameters

Domain Name Base URL (scheme + host, optionally port) of the target API. Example: https://api.example.com or http://192.168.1.10:8080

Path Endpoint path appended to the domain name. Example: /v1/users

Method HTTP verb to use: GET, POST, PUT, PATCH, DELETE

Headers Optional list of request headers in Key:Value format. Example: Content-Type:application/json

Body Optional request payload (typically JSON) for methods that support a body (POST/PUT/PATCH).

Skip SSL/TLS Verification If enabled, certificate validation is disabled for HTTPS requests (useful for self-signed certificates).

Timeout Maximum time (in seconds) to wait for a response.

Async Enables or disables asynchronous execution.

HTTP Request Action

hashtag
Output and Wildcards

The node captures the complete response and makes it available via:

The response object is structured into:

  • code — HTTP status code (e.g., 200, 404, 500)

  • headers — response headers

  • body — response payload (parsed JSON when applicable)

This structure makes it easy to extract only what you need by using the JSON Extract Action node.

hashtag
Typical Use Cases

  • creating or updating records in external systems (MAM, CMS, ticketing, etc.)

  • triggering webhooks or automation endpoints

  • fetching metadata for workflow decisions

  • sending job or delivery status updates

  • authenticating and retrieving session tokens

hashtag
Example Response (simplified)

A successful request typically returns an object like:

  • code: 200

  • headers: response header map

  • body: JSON payload (e.g., user object, token, created resource)

hashtag
Important Notes

  • The Headers field must be formatted correctly (Key:Value). Incorrect formatting may cause the request to fail or be interpreted incorrectly.

  • Use Skip SSL/TLS Verification only when necessary (e.g., internal endpoints with self-signed certs). Disabling verification reduces security.

  • For long-running endpoints, increase the Timeout or move the call to an asynchronous workflow path (e.g., Split Stream).

hashtag
Practical Tip

If you need to chain multiple API calls (login → token → next request), store the returned token from body and re-use it in the next node’s headers (e.g., Authorization: Bearer <token>).

chevron-rightExample node outputhashtag

Last updated