Skip to main content

Request Table Reference

This document provides a highly structured, comprehensive reference of all available tables, sections, and fields that can be defined inside a Rumour Request Node (.toml file).

Root-Level Directives

These parameters are configured at the absolute root level of your request .toml file. For details on retries and backoff limits, see the Retry Behavior Guide. For sequential orchestration, see the Ordered Suite Runs Guide. For lifecycle scripts, see the Pre-Request Hooks and Post-Request Hooks references.

FieldTypeRequiredDefaultDescription
skipBooleanNofalseSkips execution of this request node entirely during runner executions.
retriesIntegerNo0Number of automated attempts to re-execute a request if assertions fail.
orderedBooleanNofalseForces strict chronological execution sequencing inside collection suites.
pre_requestStringNoNonePre-execution hook script executed immediately prior to starting the request transport.
post_requestStringNoNonePost-execution hook script executed immediately after receiving the response.

The [request] Table

The core metadata defining the target transport endpoint details. For a comprehensive introduction, see the Request Nodes Guide.

FieldTypeRequiredDefaultDescription
methodStringNo"GET"HTTP verb/method (e.g. "GET", "POST", "PUT", "DELETE", "PATCH").
urlStringYes"/"The target API endpoint URL. Supports variable interpolation using {{variable}}.
skipBooleanNofalseSkips the transport step of this request node if set to true.

Transport & Context Tables

Use these sections to define headers, query parameters, payloads, and local scopes.

[headers]

Injects outgoing custom HTTP request headers. Supports string variables. Learn more in the HTTP Headers Guide.

  • Key-Values: Header-Name = "Header Value"

[params]

Appends query string parameters dynamically to the request URL. Learn more in the Query Parameters Guide.

  • Key-Values: param_name = "value"

[variables]

Defines local variables scoped strictly to the file. Supports self-referential interpolation. Learn more in the Local Variables Guide.

  • Key-Values: var_name = "value"

[body]

Configures request payload and content serialization. Learn more in the Request Body Guide.

FieldTypeRequiredDefaultDescription
typeStringNo"json"Body content-type serialization (e.g., "json", "raw").
rawStringNoNoneThe actual request payload string. Supports multiline string syntax.

The [extract] Table

Harvests dynamic parameters from responses and saves them into the runtime variable scope. Learn more in the Variable Extraction Guide.

Field PatternTarget TypeDescription
key = "json.<json_path>"StringExtracts response body field using dot-notated JSON Path (e.g., user_id = "json.id").
key = "headers.<header_name>"StringExtracts a specific header value from the HTTP response (e.g., etag_val = "headers.ETag").

The [assert] Table

Evaluates request-level testing constraints on the HTTP response. Learn more in the Basic Assertions Guide.

FieldTypeRequiredDefaultDescription
statusIntegerNoNoneExpected exact HTTP status code of the response (e.g. 200).
status_rangeStringNoNoneExpected status code range expression (e.g. "200-299").
body_containsStringNoNoneSubstring check matching against the raw text response body.
durationIntegerNoNoneMax allowed transport execution duration in milliseconds (e.g. 1000).
schemaStringNoNonePath or URL to a JSON Schema file to validate response body shape.

[assert.json."<json_path>"] and [assert.headers."<header_name>"]

Targeted validation fields for detailed leaf node or header evaluation. Learn more in the JSON Path Assertions Guide and the Response Header Assertions Guide.

Constraint FieldTypeDescription
equalJSON ValueAsserts exact equivalence matching strings, numbers, booleans, or null.
not_equalJSON ValueAsserts that the targeted field does not match the specified value.
containsStringAsserts that a target string field contains the specified substring.
existsBooleanValidates existence/presence of the field or header (true / false).
greater_thanFloatValidates that a numeric response field is greater than this value.
less_thanFloatValidates that a numeric response field is less than this value.
regexStringValidates the target string value against this regular expression pattern.

The [dependencies] Block

Declares upstream sequences that must run first to populate consumer variables. Learn more in the Dependency Overview, the Explicit Dependencies Guide, and the Producer-Consumer Model docs.

Map Format ([dependencies])

Map of path keys to target variables:

[dependencies]
"../auth/login.toml" = "accessToken"
"users/get.toml" = ["id", "email"]

List Format ([[dependencies]])

Sequential array of dependent nodes:

[[dependencies]]
producer_id = "../auth/login.toml"
consumer_var = "accessToken"