Node reference
HTTP request
Call an API with query, body, headers, and auth
Call an API with query, body, headers, and auth
Part of HTTP / HTTP. This reference is generated from the node definitions shipped with Blokboard.
When to use it#
- Call a REST API and use its JSON response in later nodes.
Browser requests are subject to CORS and other browser network restrictions. See choose a runtime.
Parameters#
| Parameter | Field type | Default | Description |
|---|---|---|---|
Method (method) | select | GET | |
URL (url) | string | (empty) | Runs in the browser when possible. APIs that block browser CORS may require Blokboard Desktop. |
Query parameters (query) | key-value-list | [] | |
Authentication (authentication) | select | none | |
HTTP credential (connectionId) | connection | (empty) | Stored encrypted in the Web Vault and resolved only while this node runs. |
Username (basicUsername) | string | (empty) | |
API key location (apiKeyLocation) | select | header | |
API key name (apiKeyName) | string | x-api-key | |
Headers (headers) | key-value-list | [] | Literal values are saved with the workflow. Use Authentication for encrypted credentials. |
Body (bodyType) | select | none | |
JSON body (jsonBody) | text | (empty) | Use an exact expression such as {{request_body}} to send an object or array directly. |
Text body (textBody) | text | (empty) | |
Form fields (formFields) | key-value-list | [] | |
Timeout (ms) (timeoutMs) | number | 30000 | Set to 0 to wait until the workflow is stopped. |
Response body (responseType) | select | auto | |
Maximum response (bytes) (maxResponseBytes) | number | 10485760 | Stops reading when the response exceeds this limit. |
On failure (onFailure) | select | stop | Choose whether a failed execution stops the workflow or only ends this path. |
Retry attempts (retryCount) | number | 0 | How many additional attempts to make after the first failure. |
Method: Choices: GET (GET), POST (POST), PUT (PUT), PATCH (PATCH), DELETE (DELETE), HEAD (HEAD), OPTIONS (OPTIONS).
Authentication: Choices: None (none), Bearer token (bearer), Basic auth (basic), API key (apiKey).
HTTP credential: Shown when authentication is not none. Select your own http connection. See connection setup.
Username: Shown when authentication is basic.
API key location: Choices: Header (header), Query parameter (query). Shown when authentication is apiKey.
API key name: Shown when authentication is apiKey.
Body: Choices: None (none), JSON (json), Text (text), Form URL encoded (form).
JSON body: Shown when bodyType is json.
Text body: Shown when bodyType is text.
Form fields: Shown when bodyType is form.
Timeout (ms): Available under More options. Limits: minimum 0; no declared maximum.
Response body: Choices: Auto detect (auto), JSON (json), Text (text). Available under More options.
Maximum response (bytes): Available under More options. Limits: minimum 1; maximum 104857600.
On failure: Choices: Stop workflow (stop), Continue (continue). Available under More options.
Retry attempts: Available under More options. Limits: minimum 0; no declared maximum.
Inputs#
| Port | Value | Description |
|---|---|---|
in | any | Optional workflow data available to parameter expressions. |
Outputs#
| Port | Value | Description |
|---|---|---|
out | object | HTTP status, response headers, and parsed response body. |
out fields#
| Field | Type | Description |
|---|---|---|
status | number | HTTP response status code. |
statusText | string | HTTP response status text. |
ok | boolean | Whether the response status is between 200 and 299. |
headers | object | Response headers keyed by lowercase name. |
body | unknown | Parsed JSON or text response body. |
durationMs | number | Elapsed request time in milliseconds. |
Use in a workflow#
Connect this node to the path that should execute it. Run a small example, inspect its actual output, and use the expression picker to select values for later nodes.
See expressions for mapping values, workflow basics for connections, and troubleshooting for failed runs.