HTTP

Overview of the HTTP BDK Book.

Overview

HTTP integration provides fundamental web communication capabilities for API interactions and web service calls. This integration supports GET, POST, PUT, DELETE, and other HTTP methods for seamless API integration. Enable your workflows to communicate with any REST API or web service.

Prerequisites

1. Required Books

The following Book(s) need to be added to your agent so it can learn and understand the automation procedures defined within them:

• HTTP (BDK)

How to Add the Book(s)

1. Go to Books from the left navigation menu.

2. Click on + New Book.

3. Search for name of the book and click on it.

4. You'll be prompted for connectivity details if the book requires configuration.

5. Click on Add to finish adding the book to your agent.

6. Publish your agent.

Connectivity

This section outlines the available methods for connecting to the Book, along with the required configuration details for each.

Basic Authentication

Connect to the HTTP server using basic authentication. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.

Label	Description	Type
Username	The username for basic authentication.	text
Password	The password for basic authentication.	sensitive

Client Credentials

Connect to the HTTP server using client credentials method. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.

Label	Description	Type
Token URL	The token URL for client credentials.	text
Client ID	The client ID for client credentials.	text
Client Secret	The client secret for client credentials.	sensitive

Digest Authentication

Connect to the HTTP server using digest authentication. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.

Label	Description	Type
Username	The username for digest authentication.	text
Password	The password for digest authentication.	sensitive

Password Grant

Connect to the HTTP server using password grant method. Note: If connect is set, "Authorization" header will be added automatically to the request and manually set "Authorization" header will be ignored.

Label	Description	Type
Token URL	The token URL for password grant.	text
Username	The username for password grant.	text
Password	The password for password grant.	sensitive
Client ID	The client ID for password grant.	text
Client Secret	The client secret for password grant.	sensitive

Configuration

The following table details all the available configuration options for this book.

Concept	Description	Type	Default Value
timeout	Get the value of the timeout.	number	30
offload threshold	The size in MB of the maximum payload size that will be returned in the response as it comes from the server.	number	5
allow insecure transport	Get the value of the allow insecure transport.	boolean	False

Configuration can be set or retrieved as shown in the following examples:

the department's HTTP's timeout is 30

the department's HTTP's offload threshold is 5