HTTP
Description
HTTP component allows to perform a HTTP call.
Parameters and configuration
Parameter names follow standard HTTP terminology. If unsure, refer to an HTTP reference such as MDN Web Docs.”
| Name | Description |
|---|---|
| URL | The target URL for the request. The URL should contain scheme - typically http or https. |
| HTTP method | the HTTP method to use: GET, POST, PUT, DELETE, etc |
| Body | The request body. Optional for methods like POST or PUT. Can be a raw expression or structured JSON. |
| Output variable name | The name of the variable that will hold the HTTP response. |
Advanced parameters
| Name | Description |
|---|---|
| Path segments | Additional segments to append to the (base) URL. Each entry will be URL-encoded and joined with "/". |
| Query parameters | Key-value pairs added as query parameters to the URL. Corresponds to the query string ?key=value&.... |
| Headers | HTTP request headers. Often used for content types, authentication, or custom metadata. |
| Body type | Defines how the body content is serialized. |
| Authorization | The following methods are supported: No Authorization (default), Basic Auth, OAuth2, Bearer Token. Every method other than No Authorization adds its own credential parameters - see Authorization below. |
| Error strategy | Determines when the HTTP response is considered successful |
Authorization
The Authorization parameter (in the Advanced section) selects how the request is authorized. Choosing a method other than No Authorization adds the parameters listed below, also in the Advanced section. All of them are mandatory and their values are fixed at design time - they cannot depend on the processed event (e.g. on #input).
| Authorization method | Parameters | How the request is authorized |
|---|---|---|
| No Authorization | - | No Authorization header is added. |
| Basic Auth | Username, Password | Username and password are sent in the Authorization header, using the Basic scheme. |
| Bearer Token | Bearer token | The token is sent verbatim in the Authorization header, using the Bearer scheme. |
| OAuth2 | Token URL, Client ID, Client secret | An access token is obtained from Token URL using the OAuth2 client credentials grant (no scope is requested) and sent as a Bearer token. The token is cached and reused across events until it expires; a request answered with 401 drops the cached token and is retried once with a newly requested one. |
For all methods other than No Authorization, the Authorization header value is masked in the request data stored in the output variable.