ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

HTTP >Make a request module

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
NOTE
ÃÛ¶¹ÊÓƵ Workfront Fusion requires an ÃÛ¶¹ÊÓƵ Workfront Fusion license in addition to an ÃÛ¶¹ÊÓƵ Workfront license.

The ÃÛ¶¹ÊÓƵ Workfront Fusion HTTP > Make a request module is a universal module that enables you to configure an HTTP request and submit it to a server. The received HTTP response is then contained in the output bundle.

NOTE
If you are connecting to an ÃÛ¶¹ÊÓƵ product that does not currently have a dedicated connector, we recommend using the ÃÛ¶¹ÊÓƵ Authenticator module.
For more information, see ÃÛ¶¹ÊÓƵ Authenticator module.

Access requirements

You must have the following access to use the functionality in this article:

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses

HTTP >Make a request module configuration

When you configure the HTTP >Make a request module, ÃÛ¶¹ÊÓƵ Workfront Fusion displays the fields listed below. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Evaluate all states as errors (except for 2xx and 3xx)

Use this option to set up error handling.

For more information, see Error handling in ÃÛ¶¹ÊÓƵ Workfront Fusion.

URL
Enter the URL you want to send a request to, such as an API endpoint, website, etc.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Headers
Add the headers of the request in the form of a standard JSON object.For example, {"Content-type":"application/json"}
Query String
Enter the desired query key-value pairs.
Body type

The HTTP Body is the data bytes transmitted in an HTTP transaction message immediately following the headers if there are any to be used.

  • Raw

    The Raw body type is generally suitable for most HTTP body requests even in situations where developer documentation does not specify data to send.

    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.

  • 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 essentially one query string. The keys and values are encoded in key-value pairs separated by & and with a = between the key and the value.

    For binary data, use multipart/form-data instead.

    Example:

    Example of the resulting HTTP request format:

    field1=value1&field2=value2

  • Multipart/form-data

    The Multipart/form-data is an HTTP multipart request used to send files and data. It is commonly used to upload files to the server.

    Add fields to be sent in the request. Each field must contain Key-Value pair.

    • Text

      Enter the key and value to be sent within the request body.

    • File

      Enter the key and specify the source file you want to send in the request body.

      Map the file you want to upload from the previous module (such as HTTP >Get a File or Google Drive >Download a File), or enter the file name and file data manually.

Parse response

Enable this option to automatically parse responses and convert JSON and XML responses so you don't need to use JSON > Parse JSON or XML > Parse XML modules.

Before you can use parsed JSON or XML content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules.

User name
Enter the user name if you want to send a request using basic authorization.
Password
Enter the password if you want to send a request using basic authorization.
Timeout
Specify the request timeout in seconds (1-300). The default is 40 seconds.
Share cookies with other HTTP modules
Enable this option to share cookies from the server with all HTTP modules in your scenario.
Self-signed certificate
Upload your certificate if you want to use TLS using your self-signed certificate.
Reject connections that are using unverified (self-signed) certificates
Enable this option to reject connections that are using unverified TLS certificates.
Follow redirect
Enable this option to follow the URL redirects with 3xx responses.
Follow all redirects
Enable this option to follow the URL redirects with all response codes.
Disable serialization of multiple same query string keys as arrays
By default, Workfront Fusion handles multiple values for the same URL query string parameter key as arrays. For example, www.test.com?foo=bar&foo=baz will be converted to www.test.com?foo[0]=bar&foo[1]=baz. Activate this option to disable this feature.
Request compressed content

Enable this option to request a compressed version of the website.

Adds an Accept-Encoding header to request compressed content.

Use Mutual TLS

Enable this option to use Mutual TLS in the HTTP request.

For more information on Mutual TLS, see Use Mutual TLS in HTTP modules in ÃÛ¶¹ÊÓƵ Workfront Fusion.

INFO
Example: This example shows how to set up the module to submit a POST request with JSON payload:
NOTE
To make sure your JSON is valid, you can use one of the available online services such as . You can also use JSON >Create JSON module to create the JSON dynamically and take care of all the necessary escaping.
Mixing JSON pieces with expressions and items directly in the Request content field is not recommended as it can result in invalid JSON.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43