Built-in apps

HTTP Agent

6min

﻿
With the HTTP Agent app in , 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 , you must have a connected system configured in your On-prem agent﻿. 
Connect HTTP Agent and  
To create the connection:
1
Log in to your  account, add an HTTP Agent module to your , and click Create a connection.
2
Optional: In the ​​Connection name​​ field, enter a name for the connection.
3
In the Connected System dropdown, select the relevant connected system from your On-prem agent.
4
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.
5
Click Save.
You've successfully created the connection and can now use the HTTP Agent app in your . If you want to make changes to your connection in the future, follow the steps here﻿.
HTTP Agent modules
The HTTP Agent module you should use depends upon the authentication/authorization mechanism of the resource you wish to access:
﻿Make a Request﻿: This is a universal module, best to use for resources that do not require authentication.
﻿Make an API Key Auth Request﻿: This is for resources that require API key authentication.
﻿Make a Basic Auth Request﻿: This is for resources that require basic authentication.
Actions
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.
﻿
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.
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.
﻿

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.

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.

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.

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.

HTTP

Image