Skip to content

HTTP Services (system.http)

This namespace provides services for interacting with external web services via REST/HTTP.

Services

system.http:Request

Makes an outbound HTTP request.

  • Inputs:

    • url: (string) The target URL. Supports ${var} substitution if enabled.
    • method: (string) GET, POST, PUT, DELETE, etc.
    • data: (any) The request body (automatically JSON-encoded if object).
    • headers: (object) Custom HTTP headers.
    • auth: (object) Authentication configuration.
      • type: "basic", "bearer", or "apikey".
      • (other fields based on type).
    • timeout: (int) Timeout in seconds.
  • Outputs:

    • status: (int) HTTP status code.
    • body: (string) The response body as a string.
    • headers: (object) The response headers.
    • responseBytes: (bytes) Raw response body.

Smart URL Substitution

By default, the url field supports dynamic variable binding using the ${pipelineField} syntax. This allows you to construct URLs dynamically from the pipeline.

Released under the ISC License.