Skip to main content

HTTP Request

Description​

Make an HTTP call. Enables performing HTTP requests to a specified web application.

Configuration​

This activity allows you to configure at design time by clicking on the Configure button available as part of the body of this activity. This will bring up a configuration dialog that helps you specify the API to be called and its parameters to be sent and received.

Properties​

Input​

  • Accept Format - The format in which to receive the web API response. Supported formats are:

    • Any
    • Json (Default)
    • Xml
    • YAML

  • Authentication Type – Type of the authentication to be used for the request. Following authentication types are supported:

  • Host – Address for target point. Custom URL segments have to be placed between braces "{}" and provide values in URL segements.

  • Inherit Authorization - If set to true, inherits the authorization from the parent Authorization Scope activity

  • Method – The request method to be used when calling the API. The following methods are currently supported:

    • GET
    • POST (Default)
    • PUT
    • DELETE
    • HEAD
    • OPTIONS
    • PATCH

Misc​

  • DisplayName – Add a display name to your activity.
  • Private – By default, activity will log the values of your properties inside your workflow. If private is selected, then it stops logging.

Optional​

  • Attachments – Enables you to attach files to the request

  • body – Body of the request

  • Body Format – It specifies the format of the request's body. Following formats are supported.

    Body Format

  • Continue On Error – It Specifies whether the automation should continue even when the Activity throws an error. If True, the Activity continues without throwing any exceptions. If False, the Activity throws an exception. The default value is False.

    note

    Catches no error if this Activity is present inside the Try-Catch block and the value of this property is True.

  • Cookies - Enables you to include custom cookies in the request

  • Headers – Enables you to include custom headers in the request

  • Parameters – Enables you to include custom text parameters in the request

  • Query Params - Enables you to include custom query parameters in the request

  • Save Response To - Saves response to the specified file path.

  • Timeout - Specifies the amount of time (in seconds) to wait for the request to complete. The default value is 10 seconds.

  • URL Segments - URL segments added to the host URL between braces '{}'. For example, the https://jsonplaceholder.typicode.com/posts/1 URL can be written as https://jsonplaceholder.typicode.com/posts/{id}, and the value of the id parameter can be provided in the URL Segments.

Output​

  • Response - Response returned by HTTP call

  • Response Cookies – Cookies returned by HTTP call

  • Response Headers – Headers returned by HTTP call

  • Result – Response Result returned by HTTP call

  • Status Code – Status Code returned by HTTP call

    Note: If the returned HTTP status code (StatusCode) is 0, the server did not return an actual response for some reason. This usually points to some connectivity or network issues.

Example​

Download Example