All categories
System
Access management
AI
Appflows - Technical
Billing
Billing and policy
Built-in apps
Business cases addon
Business Intelligence
Business Operations and ERPs
Calendar addon
Commerce
Communication
Community apps
Contacts module
Contracts addon
CRM and Sales tools
Customer Support
Database
Education
Features
File and Document Management
Forms Addon (Legacy)
Getting started with Boost.space
HR management
Internet of Things
Invoices module
IT and Development
language-tools
Lifestyle
Marketing
Marketplace - Overview
Marketplaces
Modules and Addons
News monitor addon (legacy)
Notes addon
Offers addon
Orders module
Other
Pages addon
Policy
Process Management
Productivity
Products module
Projects addon
Records
Spaces
Surveys and Forms
System Settings (for Admins)
Tasks module
Travel
Users and teams
Wall addon
Warehouses addon
Website Building
Work hours addon
Integrations
Apps
Connections
Errors
Functions
Getting started with Boost.space Integrator
Integrator Modules
Mapping
Scenarios
Tools
Tutorials
List of applications
Table of Contents
Active
This application does not need additional settings. So you can make connection only by using your login credentials or by following the instructions below .

HTTP Agent

With HTTP Agent modules in Boost.space Integrator, you can connect to your On-prem agent and make HTTP(S) requests, including for resources that require HTTP Basic and API Key authorizations.

The HTTP Agent module you should use depends upon the authentication/authorization mechanism of the resource you wish to access:

Connect HTTP Agent to Boost.space Integrator

Establishing a connection to the HTTP Agent in Boost.space Integrator differs for each HTTP Agent module, depending on the authorization type. Follow the connection procedure below and insert the specific information for the HTTP Agent module you want to connect to.

[Note] Note
You must already have a connected system configured in your On-prem agent to establish a connection to the HTTP Agent modules in Boost.space Integrator.

 

  1. Log in to your Boost.space Integrator account, add the HTTP Agent module with the desired authorization type to your scenario, 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.
    [Tip] Tip
    You can always check which connected system is associated with the specific On-prem agent in the On-prem agents section, on the Organization dashboard.
  4. Depending on the HTTP Agent module you have selected, input the following:

     

    Module Field 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 have successfully established the connection. You can now edit your scenario and add more HTTP Agent modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.

Use HTTP Agent Modules

With HTTP Agent Modules in Boost.space Integrator, you can send HTTP(S) requests to specified URLs, including those that require Basic Auth and API Key Auth authorizations, and process the responses.

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.

 

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
Raw 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.
Application/x-www-form-urlencoded This body type is 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.

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
Raw 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.
Application/x-www-form-urlencoded This body type is 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.

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
Raw 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.
Application/x-www-form-urlencoded This body type is 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.