The HTTP Client function enables communication with a third-party HTTP server. Using it stream editors can control outgoing requests handling. This function supports REST API and also supports authentication via the OAuth 2.0 framework. The following HTTP Client functions are available in :
...
Select an HTTP request method from the following options:
HTTP Method Description GET Requests data from the target server POST Sends data to the target server. Select either Body or Form under Content* PUT Replaces current resources of the target URL with the uploaded content. Select either Body or Form under Content* PATCH Updates partial resources of the target URL. Select either Body or Form under Content* DELETE Removes all current representation of the target resource Note title Note! *The Body and Form fields are visible only for request methods POST, PUT and PATCH.
- Select Body or Form and add the corresponding details in the content of the request message. You can use Variable Insertion.
- Expand the examples below to view samples of HTTP request messages for Body or Form:
Note title Note! The form input needs to be URL encoded, otherwise, it fails.
HTTP requests use a hardcoded content-type value of ‘application/x-www-form-urlencoded’.
Expand title Sample of an HTTP body content message No Format { "name" : "my_username", "first-name" : "My", "last-name" : "Username", "display-name" : "My Username", "email" : "user@example.test", "active" : true }Expand title Sample of an HTTP form content message No Format name=my_username&first-name=My&last-name=Username&display-name=My%20Username&email=user@example.test&active=true
- Select Body or Form and add the corresponding details in the content of the request message. You can use Variable Insertion.
In Target URL, enter the URL of the target HTTP server. You can use Variable Insertion. You can select a combination of the following options to be included in the URL:
Option Description Include basic access authentication credentials Select to add the specified username and password 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 HTTP header “content-type”.
It is recommended that the default value for HTTP header "accept" is left unchanged. The HTTP functions only support application/json.
OAuth 2.0 Authorization
The HTTP Method, Target URL, and their associated options are configured in the same way. When the Authentication type selection is selected as OAuth 2.0 additional options are displayed. Their configuration is mandatory to properly activate the function.
It is also possible to use the Secrets Wallet functionality to apply stored credentials for the three HTTP functions.
The Use Redirect Fields checkbox allows users to toggle URL redirection using the available options. Two fields are displayed when this option is enabled – the Target URL field where the designated address is to be entered, and an optional Resource Path.
The Configure Token section of the function controls the authentication token credentials. The Header Prefix field is the Authorization header placed before the access token. Based on the Grant Type selection there are two types of credentials access provided for the authentication provisions – Password and Client credentials. Each of them has a distinctive configuration option.
...
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 as 4xx or 5xx is considered as an error. All errors get logged in the system logs. You can refer to the Logs for more information. The default value is Ignore.
...