Blocks & Flow EditorCommon

http request

Send HTTP requests to REST APIs and external web services

The http request block makes an HTTP call to a given URL. Use it to integrate with REST APIs, webhooks, and third-party services.

Bot Studio http request block configuration

Configuration

FieldDescription
NameOptional display label on the canvas.
MethodHTTP verb: GET, POST, PUT, DELETE, or PATCH.
URLRequest URL. Supports dynamic values using {variable} syntax from msg properties.
HeadersRequest headers as JSON (e.g. {"Content-Type": "application/json"}). Supports {payload} and other message references.
Body TypeJson — raw JSON body. FormData — key/value form fields with file support.
Body (Json mode)Request body content. Use {payload} to send msg.payload, or a JSON template with {variable} placeholders.
Body (FormData mode)List of form fields. Each row has Data Type (TEXT or FILE), key, and value. Click + element to add fields.

FormData field types

TypeDescription
TEXTText form field
FILEFile upload field — value is the file path

Outputs

PortDescription
Output 1Response body in msg.payload. Status code and headers are available on the message object for downstream blocks.

Notes

  • Use {variable} in URL, headers, and body to substitute values from the incoming message dynamically
  • For authenticated APIs, set headers such as Authorization in the Headers field
  • Pair with catch blocks to handle HTTP errors
  • GET requests typically omit the body