feat: switch default HTTP client to httpx2 and accept a custom http_client (#731)

Author: gjtorikian

README.md

@@ -138,6 +138,81 @@ except RateLimitExceededError as e:
 
 The client automatically retries requests up to 3 times (configurable via the `max_retries` request option) on 429 and 5xx responses, timeouts, and connection errors, using exponential backoff with jitter and honoring `Retry-After`. The SDK attaches an auto-generated `Idempotency-Key` (UUID v4) to every `POST` request and reuses the same key across its internal retries.
 
+## HTTP Backends
+
+The SDK sends requests through [`httpx2`](https://pypi.org/project/httpx2/) by default. Pass your own configured client as `http_client` to control proxies, TLS, connection limits, or transports:
+
+```python
+import httpx2
+from workos import AsyncWorkOSClient, WorkOSClient
+
+client = WorkOSClient(
+    api_key="sk_...",
+    http_client=httpx2.Client(proxy="http://proxy.internal:3128", verify="/etc/ssl/corp.pem"),
+)
+
+async_client = AsyncWorkOSClient(
+    api_key="sk_...",
+    http_client=httpx2.AsyncClient(limits=httpx2.Limits(max_connections=20)),
+)
+```
+
+`httpx` 0.28 clients are accepted as well; the two libraries share an API. The SDK closes only clients it created. A client you pass in stays open after `client.close()`, so close it yourself when you are done with it.
+
+### Custom backends
+
+Any object implementing `workos.HTTPBackend` (or `workos.AsyncHTTPBackend` for the async client) can be passed as `http_client`. The SDK hands the backend a fully built URL, the final headers, an optional `bytes` body, and a timeout in seconds, and expects a `workos.HTTPResponse` back. Raise `workos.TransportTimeout`, `workos.TransportConnectError`, or `workos.TransportError` for network failures so the SDK's retry logic can handle them. The `headers` mapping on the response must be case-insensitive.
+
+The following `aiohttp` adapter is an example, not a supported part of the SDK:
+
+```python
+import asyncio
+
+import aiohttp
+import yarl
+
+from workos import (
+    AsyncWorkOSClient,
+    HTTPResponse,
+    TransportConnectError,
+    TransportError,
+    TransportTimeout,
+)
+
+
+class AiohttpBackend:
+    def __init__(self, session: aiohttp.ClientSession) -> None:
+        self._session = session
+
+    async def request(self, method, url, *, headers, content, timeout) -> HTTPResponse:
+        try:
+            async with self._session.request(
+                method,
+                yarl.URL(url, encoded=True),  # keep the SDK's percent-encoding intact
+                headers=headers,
+                data=content,
+                timeout=aiohttp.ClientTimeout(total=timeout),
+                allow_redirects=True,
+            ) as resp:
+                body = await resp.read()
+                return HTTPResponse(resp.status, resp.headers, body, method, str(resp.url))
+        except (asyncio.TimeoutError, aiohttp.ServerTimeoutError) as exc:  # before connection errors
+            raise TransportTimeout(str(exc)) from exc
+        except aiohttp.ClientConnectionError as exc:
+            raise TransportConnectError(str(exc)) from exc
+        except aiohttp.ClientError as exc:
+            raise TransportError(str(exc)) from exc
+
+    async def close(self) -> None:
+        await self._session.close()
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as session:
+        client = AsyncWorkOSClient(api_key="sk_...", http_client=AiohttpBackend(session))
+        page = await client.organizations.list_organizations()
+```
+
 ## Per-Request Options
 
 Every API method accepts `request_options` for per-call overrides (local helpers such as webhook/Actions signature verification and PKCE utilities do not make HTTP calls and don't take `request_options`):

pyproject.toml

@@ -9,7 +9,7 @@ requires-python = ">=3.10"
 
 dependencies = [
   "cryptography~=50.0",
-  "httpx~=0.28",
+  "httpx2~=2.13",
   "pyjwt~=2.12",
   "typing_extensions~=4.0; python_version < '3.11'",
 ]
@@ -31,10 +31,10 @@ test = [
   "pytest~=9.0",
   "pytest-asyncio~=1.3",
   "pytest-cov~=7.1",
-  "pytest-httpx~=0.36",
+  "httpx~=0.28",
 ]
 lint = ["ruff~=0.15"]
-type_check = ["pyright~=1.1"]
+type_check = ["pyright~=1.1", "httpx~=0.28"]
 nox = ["nox~=2026.2", "nox-uv~=0.7"]
 docs = ["pdoc>=14", "pydoc-markdown>=4", "black~=26.3"]
 

src/workos/__init__.py

@@ -14,6 +14,14 @@
     ServerError,
     UnprocessableEntityError,
 )
+from ._http import (
+    AsyncHTTPBackend,
+    HTTPBackend,
+    HTTPResponse,
+    TransportConnectError,
+    TransportError,
+    TransportTimeout,
+)
 from ._pagination import AsyncPage, ListMetadata, SyncPage
 from .public_client import create_public_client
 from ._types import NOT_GIVEN, NotGiven, RequestOptions
@@ -37,4 +45,10 @@
     "NOT_GIVEN",
     "NotGiven",
     "create_public_client",
+    "HTTPBackend",
+    "AsyncHTTPBackend",
+    "HTTPResponse",
+    "TransportError",
+    "TransportTimeout",
+    "TransportConnectError",
 ]