HTTP Request Documentation

Version: 7.3.0

Retrieved: 2025-10-09 15:15:55

HTTP Request Module

This module makes a HTTP request to the specified URL and passes the result to the next module(s).

Settings

Name Requirements Purpose Default
URL * Length: 0-256 The URL to use in the request ``
Credential Credential section The credential to use ``
Target Property Length: 1-64 The property that will contain the response data
Verb * Verb section The verb to use GET
Extra Headers   Extra headers to be sent with the request ``
Headers Property Header section Header to add from property on the incoming message. ``
Body * Length: 0-2048 The body/content of the request ``
Request Content-Type Length: 0-64 The content-type to use when passing in a body application/json
Allow Invalid Certificate Boolean Ignore certificate errors. Useful if the server is using a self-signed certificate false
Timeout Range: 5-500 The request timeout in seconds 15
Ignore Content-Type on response Boolean When this is true the body will be parsed using the Response Content-Type option false
Response Content-Type   How to parse the response body when Ignore Content-Type on response is set to true JSON
Include Response Headers Boolean Include response headers in output false
Bypass Proxy Boolean Make the request bypassing any configured proxy, if possible. false

Verb

Verb will be selected from a drop-down and the valid options are:

  • NONE (if this is used the verb has to be present on the incoming message)
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

Credential

This module contains an option to select credentials to use in the module. All credentials supported by the module are presented in a drop-down.

Headers Property

You can add extra custom headers from the incoming message by specifying a property that should contain key/value of type string.

  • Headers Property = headers
{
    'headers': {
        'Custom-Header': 'Custom Header Value',
        'Another-Header': 'Another Value',
        'number': 123,
        'object': { 'name': 'test'}
    }
}

The module will now pick up the first two and add them as headers. Since the last two are not strings they will be ignored.

Input

All settings marked with a * can be passed in on the incoming message. So for example we can set the body by passing in a message like this.

{
    'body':'Hello World'
}

Note that setting will always be used if set, so (for example) body is set in setting the body on the message will not be used.

Output

The result from the request will be written to the Target Property property and will contain statuscode, duration and body. The output will also contain the crosser object on root level.

Basic Example

Settings

  • URL = https://jsonplaceholder.typicode.com/todos/1
  • Verb = GET
  • Target Property = response
  • Response Content-Type = JSON

Input

{
    'foo':'Hello'
}

Output

{
    'foo':'Hello',
    'response': {
        'statuscode': 200,
        'duration': 135,
        'body': {
            "userId": 1,
            "id": 1,
            "title": "delectus aut autem",
            "completed": false
        }
    },
    'crosser':{
        'success': true
    },
}

Template Syntax Example

Settings

  • URL = {input.url}
  • Body = {input.content}
  • Verb = POST
  • Target Property = response
  • Response Content-Type = JSON

Input

{
    'input': {
        'url': 'https://api.example.com/people',
        'content': {
            'name': 'steve',
            'age': 35
        }
    }
}

Output

{
    'response': {
        'statuscode': 201,
        'duration': 135,
        'body': {
            'id': 123,
            'name': 'steve',
            'age': 35
        }
    },
    'crosser':{
        'success': true
    },
}

Search Documentation

Protocols