HTTP Client (Collector)
- Casey Han
The HTTP Client collector function collects data from a third-party HTTP server. You can configure this function to set the values for how the HTTP Client function would behave when communicating with the third-party HTTP server, and specify the method of communication.
You can configure this function in the following settings:
Connection
Depending on your configuration, three authentication methods are available: None, Basic authentication and OAuth 2.0.
When you select an Authentication type, there will be separate configuration options for the selected authentication type.
Operational settings
In Operational settings, enter the following details that determine how you want the function to behave.
In Request run limit, specify the number of times the operation should run in a single stream. The limit of runs you can request is from one to 12.
In Action on error, specify the action you want to take in case of an error. You can select from the following options:
Action on error options | Description |
|---|---|
Ignore | Select to ignore the error and the stream keeps on running. |
Stop the stream | Select to stop the stream. |
Any response with the HTTP status code 4xx or 5xx is considered an error. All errors get logged in the system logs. See Logs for more information.
The default value is Ignore.
General settings
In General settings, you select an HTTP request method from the following options:
HTTP Method | Description |
|---|---|
GET | Request data from the target server. |
POST | Sends data to the target server. Select either Body or Form under Contents*. |
PUT | Replaces the current resources of the target URL with the uploaded content. Select either Body or Form under Contents*. |
PATCH | Updates partial resources of the target URL. Select either Body or Form under Contents*. |
DELETE | Removes all current representations of the target resource. |
Note!
*The Body and Form fields are visible only for the POST, PUT and PATCH request methods. See Contents for more information.
You can select a combination of the following options to be included:
Option | Description |
|---|---|
Include query string in URL | Select to include a query string in the URL. Add a Key and its corresponding Value. You can include multiple query strings. |
Customize header | Select to customize the headers of the URL and specify multiple keys and their respective values. The default value for the HTTP headers “content-type” and “accept” is application/json. You can override the default value for the HTTP header “content-type.” It is recommended that the default value for the HTTP header “accept” is left unchanged. The HTTP functions only support application/json. |
Results
In Result key, you can assign a name to the result that you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable. The default value is httpResponse.
The support for response headers can be enabled by toggling on the Enable response headers option. A default value for the Result headers Key will be added by the engine (httpResponseHeaders) which will match the placeholder for the key input.
HTTP Response Headers Support
By enabling response headers, the overall data size of the HTTP packets will also increase. Caching of the body check box is tied to the headers.
This option is available only for the collector and the processor functions.
Token Renewal Support
The collector and processor functions support token renewal, if the servers return a 401 Token Expiry error.