> For the complete documentation index, see [llms.txt](https://coldbox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox.ortusbooks.com/ecosystem/http-client.md).

# HTTP Client

Make outbound HTTP requests from ColdBox with hyper — a fluent, builder-style HTTP client.

**hyper** is the ecosystem's fluent HTTP client for calling external APIs — a builder-style alternative to raw `cfhttp`/`http()` calls.

```bash
box install hyper
```

📖 **Full documentation:** [hyper.ortusbooks.com](https://hyper.ortusbooks.com)

## Quick Example

```javascript
property name="hyper" inject="HyperBuilder@hyper";

var response = hyper
    .baseUrl( "https://api.stripe.com/v1" )
    .withHeaders( { "Authorization" : "Bearer #settings.stripeKey#" } )
    .post( "/charges", {
        "amount"   : 2000,
        "currency" : "usd",
        "source"   : rc.token
    } )

if ( response.isSuccess() ) {
    var charge = response.json()
}
```

## Why Not Raw `http()`?

* **Fluent, readable call sites** — headers, auth, query params, bodies compose naturally
* **Consistent response object** — `isSuccess()`, `json()`, `statusCode()` regardless of engine quirks
* **Testable** — fake and assert on requests in your test suite
* **Reusable clients** — pre-configure a builder per API and inject it as a singleton

## When to Use It

* Consuming third-party REST APIs
* Microservice-to-microservice calls
* Webhook delivery and verification

## See Also

* [Security](/ecosystem/security.md) — signing and verifying webhook signatures
* [Queues](/ecosystem/queues.md) — queue outbound calls that can tolerate latency


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox.ortusbooks.com/ecosystem/http-client.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.