core / action / schema v1
HTTP Request
Make an HTTP request to any API or URL
Prerequisites
No connection prerequisite is declared for this node.
Parameters
| Parameter | Type | Description |
|---|---|---|
URLurl | text Required | |
Methodmethod | select Required | Options: GET (GET), POST (POST), PUT (PUT), PATCH (PATCH), DELETE (DELETE) |
AuthenticationauthType | select Optional Default: | Adds the right Authorization/API-key header for you, no need to type it into Headers by hand. Options: None (none), Bearer Token (bearer), Basic Auth (basic), API Key Header (apiKey) |
TokenauthToken | text Conditionally required | Sent as "Authorization: Bearer <token>". Supports {{expression}} interpolation, e.g. a value from an earlier node.Field conditions{
"visible": {
"key": "authType",
"values": [
"bearer"
]
},
"required": {
"key": "authType",
"values": [
"bearer"
]
}
} |
UsernameauthUsername | text Optional | Combined with Password into a base64 "Authorization: Basic <username>:<password>" header. Leave Password empty for a username-only key (e.g. an API key sent as the username).Field conditions{
"visible": {
"key": "authType",
"values": [
"basic"
]
}
} |
PasswordauthPassword | text Optional | Combined with Username into a base64 "Authorization: Basic <username>:<password>" header. Leave Username empty for a password-only key.Field conditions{
"visible": {
"key": "authType",
"values": [
"basic"
]
}
} |
Header nameauthHeaderName | text Optional Default: | Name of the custom header carrying the API key, e.g. "X-API-Key". Defaults to "X-API-Key" if left empty.Field conditions{
"visible": {
"key": "authType",
"values": [
"apiKey"
]
}
} |
Header valueauthHeaderValue | text Conditionally required | Value sent in the custom header named above. Supports {{expression}} interpolation.Field conditions{
"visible": {
"key": "authType",
"values": [
"apiKey"
]
},
"required": {
"key": "authType",
"values": [
"apiKey"
]
}
} |
Headersheaders | key_value Optional | Manually-typed headers always win. If you set the same header name here as the Authentication section above, this value is used instead. |
Bodybody | key_value Optional | JSON body fields to send in the request |
Query Parametersparams | key_value Optional | URL query parameters (?key=value) |
Timeout (ms)timeout | number Optional | Max wait time in ms (default 10000) |
Extract fieldresponseField | text Optional | Dot-path to extract from response, e.g. data.items.0.name |
Inputs and outputs
Inputs
execute- Execute (input)
Outputs
done- Done (output)status- Status Code (output)body- Response Body (output)headers- Response Headers (output)responseStatus- Status Code (this request) (output)responseBody- Response Body (this request) (output)responseHeaders- Response Headers (this request) (output)error- Error (output)
Output data schema
[
{
"key": "status",
"type": "number",
"label": "Status Code",
"description": "HTTP response status (200, 404, 500…).",
"example": 200
},
{
"key": "body",
"type": "object",
"label": "Response Body",
"description": "The parsed response body. Its shape depends on the API you called.",
"optional": true
},
{
"key": "headers",
"type": "object",
"label": "Response Headers",
"description": "Response headers as a key/value object."
},
{
"key": "responseStatus",
"type": "number",
"label": "Status Code (this request)",
"description": "Same as {{status}}, but never shadowed by another node’s own {{status}} (e.g. a Twitch redeem trigger’s fulfillment state).",
"example": 200
},
{
"key": "responseBody",
"type": "object",
"label": "Response Body (this request)",
"description": "Same as {{body}}, but never shadowed by an upstream Webhook trigger’s own {{body}}.",
"optional": true
},
{
"key": "responseHeaders",
"type": "object",
"label": "Response Headers (this request)",
"description": "Same as {{headers}}, but never shadowed by an upstream Webhook trigger’s own {{headers}}."
}
]Examples and troubleshooting have not yet been reviewed for this contract.
Version and compatibility
This reference follows the current authoring contract. Existing workflows retain their saved node revisions.
Contract identifier
f39744d6d2389027350c7de1b3c1570df6db7d4686a546128c2265a1fbe93200