FYI.Client (FYI v1.0.2)

Centralized HTTP client for FYI sinks.

Provides a configured Req client with:

Automatic retries for transient failures (network errors, 5xx responses)
Exponential backoff (1s, 2s, 4s)
Connection pooling via Finch
Respect for Retry-After headers

Configuration

By default, the client will:

Retry transient failures (network errors, 500-599 status codes) up to 3 times
Use exponential backoff: 1s, 2s, 4s
Honor Retry-After response headers

You can customize retry behavior in your config:

config :fyi,
  http_client: [
    max_retries: 5,
    retry_delay: fn attempt -> attempt * 2000 end
  ]

Set max_retries: 0 to disable retries entirely.

Examples

# Simple POST request
FYI.Client.post("https://api.example.com/webhook", json: %{text: "Hello"})
#=> {:ok, %Req.Response{status: 200, ...}}

# With custom options
FYI.Client.post(
  "https://api.example.com/webhook",
  json: %{text: "Hello"},
  headers: [{"authorization", "Bearer token"}]
)

Summary

Functions

new(opts \\ [])

Creates a new configured Req client.

post(url, opts \\ [])

Makes a POST request using the configured client.

Functions

new(opts \\ [])

@spec new(keyword()) :: Req.Request.t()

Creates a new configured Req client.

The client includes retry logic and connection pooling.

post(url, opts \\ [])

@spec post(
  String.t(),
  keyword()
) :: {:ok, Req.Response.t()} | {:error, Exception.t()}

Makes a POST request using the configured client.

Returns {:ok, response} or {:error, exception}.

Options

All standard Req options are supported. Common ones:

:json - Request body as JSON
:headers - List of header tuples
:receive_timeout - Request timeout in milliseconds

Examples

FYI.Client.post("https://hooks.slack.com/...", json: %{text: "Hello"})
#=> {:ok, %Req.Response{status: 200, body: "ok"}}

FYI.Client.post("https://api.telegram.org/bot.../sendMessage", json: %{
  chat_id: "123",
  text: "Hello"
})
#=> {:ok, %Req.Response{status: 200, body: %{"ok" => true}}}