HTTP Agent

with the http agent app in {{product name}} , you can connect to your on prem agent and make http(s) requests this feature is available to enterprise customers requirements to use the http agent app in {{product name}} , you must have a connected system configured in your on premise agent docid 2d2 hut5eujnkigszp0vm connect http agent and {{product name}} to create the connection log in to your {{product name}} account, add an http agent module to your {{scenario singular lowercase}} , and click create a connection optional in the ​​ connection name​​ field, enter a name for the connection in the connected system dropdown, select the relevant connected system from your on prem agent depending on the http agent module you have selected, input the following module field and input make a request make an api key auth request api key paste your api key from the 3rd party account of the connected system you chose refer to the specific system's documentation on how to generate an api key placement select whether the api key will be placed as a header or as a query parameter api key parameter name enter a name for the api key parameter make a basic auth request username enter your account username for your 3rd party account of the connected system you chose password enter your account password for your 3rd party account of the connected system you chose click save you've successfully created the connection and can now use the http agent app in your {{scenario plural lowercase}} if you want to make changes to your connection in the future, follow the steps connect an application docid\ so88fm6pkt0g adkddfzz http agent modules the http agent module you should use depends upon the authentication/authorization mechanism of the resource you wish to access http agent docid\ mpnsse 9rq0mt3h0svm8c this is a universal module, best to use for resources that do not require authentication http agent docid\ mpnsse 9rq0mt3h0svm8c this is for resources that require api key authentication http agent docid\ mpnsse 9rq0mt3h0svm8c this is for resources that require basic authentication actions make a request send an http(s) request to a specified url and process the response the received http(s) response is then contained in the output bundle field description connection establish a connection to http agent url enter the connected system request url method select or map the http method you want to use get to retrieve information for an entry head to retrieve headers post to create an entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry options to retrieve communication options headers enter or map desired request headers for example, an authorization by default, the request does not contain the accept header if an unexpected response is returned, try adding the accept / header query string enter or map the desired query key value pairs body type the raw body type is suitable for most http requests, even if the service documentation does not specify the data type specify a form of parsing the data in the content type field despite the content type selected, data is entered in any format that is stipulated or required by the developer documentation content type map or select an option to set the content type request headers if you select the custom option, a field will populate to enter a custom content type value request content enter the body request content in the json format you can use the json > create json module or enter the json content manually the application/x www form urlencoded body type is used to post data using application/x www form urlencoded for application/x www form urlencoded , the body of the http message sent to the server is one query string the keys and values are encoded in key value pairs separated by & and with a = between the key and the value not suitable to use with binary data (use multipart/form data instead) example of the resulting http request format field1=value1\&field2=value2 form fields add or map form fields content type application/x www form urlencoded header is added automatically parse response enable this option to automatically parse responses and convert json responses so you don't need to use the json > parse json module note before you can use parsed content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules make an api key auth request send an http(s) request to a specified url that requires api key auth authorization and process the response the received http(s) response is then contained in the output bundle field description connection establish a connection to http agent url enter the connected system request url method select or map the http method you want to use get to retrieve information for an entry head to retrieve headers post to create an entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry options to retrieve communication options headers enter or map desired request headers for example, an authorization by default, the request does not contain the accept header if an unexpected response is returned, try adding the accept / header query string enter or map the desired query key value pairs body type the raw body type is suitable for most http requests, even if the service documentation does not specify the data type specify a form of parsing the data in the content type field despite the content type selected, data is entered in any format that is stipulated or required by the developer documentation content type map or select an option to set the content type request headers if you select the custom option, a field will populate to enter a custom content type value request content enter the body request content in the json format you can use the json > create json module or enter the json content manually the application/x www form urlencoded body type is used to post data using application/x www form urlencoded for application/x www form urlencoded , the body of the http message sent to the server is one query string the keys and values are encoded in key value pairs separated by & and with a = between the key and the value not suitable to use with binary data (use multipart/form data instead) example of the resulting http request format field1=value1\&field2=value2 form fields add or map form fields content type application/x www form urlencoded header is added automatically parse response enable this option to automatically parse responses and convert json responses so you don't need to use the json > parse json module note before you can use parsed content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules timeout specify the request timeout in seconds (1 300) default 300 seconds this value controls two timeouts read timeout and connection timeout read timeout is a time to wait for a server to send response headers (and start the response body) before aborting the request connection timeout sets the socket to timeout after timeout milliseconds of inactivity make a basic auth request send an http(s) request to a specified url that requires basic auth authorization and process the response the received http(s) response is then contained in the output bundle field description connection establish a connection to http agent url enter the connected system request url method select or map the http method you want to use get to retrieve information for an entry head to retrieve headers post to create an entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry options to retrieve communication options headers enter or map desired request headers for example, an authorization by default, the request does not contain the accept header if an unexpected response is returned, try adding the accept / header query string enter or map the desired query key value pairs body type the raw body type is suitable for most http requests, even if the service documentation does not specify the data type specify a form of parsing the data in the content type field despite the content type selected, data is entered in any format that is stipulated or required by the developer documentation content type map or select an option to set the content type request headers if you select the custom option, a field will populate to enter a custom content type value request content enter the body request content in the json format you can use the json > create json module or enter the json content manually the application/x www form urlencoded body type is used to post data using application/x www form urlencoded for application/x www form urlencoded , the body of the http message sent to the server is one query string the keys and values are encoded in key value pairs separated by & and with a = between the key and the value not suitable to use with binary data (use multipart/form data instead) example of the resulting http request format field1=value1\&field2=value2 form fields add or map form fields content type application/x www form urlencoded header is added automatically parse response enable this option to automatically parse responses and convert json responses so you don't need to use the json > parse json module note before you can use parsed content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules timeout specify the request timeout in seconds (1 300) default 300 seconds this value controls two timeouts read timeout and connection timeout read timeout is a time to wait for a server to send response headers (and start the response body) before aborting the request connection timeout sets the socket to timeout after timeout milliseconds of inactivity