Webhooks CLI

Webhooks CLI is a monitoring and debugging developer tool for Flute webhooks.

It is a command-line and terminal UI application that can display call statuses, inspect delivery logs, manage endpoints, and forward live webhook payloads. The tool can initiate and test webhook calls, including creating new webhooks and using existing ones. It supports all Flute webhook endpoints.

Download and install the application for your platform. It does not require a global installation and runs from any directory.

macOS / Linux (curl)

curl -LsSf https://github.com/getflute/flute-webhooks-cli/releases/latest/download/flute-webhooks-cli-installer.sh | sh

macOS / Linux (Homebrew)

brew install getflute/flute-webhooks-cli/flute-webhooks-cli

Windows (x64, PowerShell)

irm https://github.com/getflute/flute-webhooks-cli/releases/latest/download/flute-webhooks-cli-installer.ps1 | iex

When launched, the application automatically checks for a newer version. When a newer version exists, a non-blocking notice displays.

To update, run:

flute-webhooks-cli update

Then launch the application again.

An optional configuration file is automatically created at ~/.flute/config.toml.

Use --profile to select a profile (global flag, accepted before or after the subcommand). The active profile is shown in the dashboard title.

flute-webhooks-cli auth login

You will be prompted for your client_id and client_secret. The secret prompt is hidden. Credentials are stored in your OS keychain and never written to disk in plaintext.

By default, credentials are stored for the sandbox profile. To set up production:

flute-webhooks-cli --profile production auth login

To print the current bearer token (useful for curl smoke tests):

flute-webhooks-cli auth token

Webhooks CLI runs in two modes: TUI (terminal user interface) and command line.

The TUI is an interactive interface that runs in a terminal window. Use arrow keys to navigate rows, expand items, and toggle checkboxes.

To start the TUI:

flute-webhooks-cli tui

While typing in a text field (URL or Name), single-character keys such as q, c, d, e, p, r, l, and t are treated as literal characters and will not trigger TUI commands.

The CLI mode issues instructions through the terminal and is scriptable. For example:

flute-webhooks-cli webhooks endpoints list
flute-webhooks-cli --output json webhooks deliveries list --limit 15 | jq

Endpoints

flute-webhooks-cli webhooks endpoints list
flute-webhooks-cli webhooks endpoints get <id>
flute-webhooks-cli webhooks endpoints create --url https://… --events transaction.card.captured,refund.completed [--name "My Hook"]
flute-webhooks-cli webhooks endpoints update <id> [--url …] [--events …] [--name …] [--status active|inactive]
flute-webhooks-cli webhooks endpoints delete <id> --yes
flute-webhooks-cli webhooks endpoints ping <id>

Event types

flute-webhooks-cli webhooks event-types list

Delivery logs

flute-webhooks-cli webhooks deliveries list [--endpoint-id <id>] [--status success|failed] [--limit 50]
flute-webhooks-cli webhooks deliveries get <id>
flute-webhooks-cli webhooks deliveries retry <id>

Headless listener

Forwards every new successful delivery's headers and body to a local URL. Runs in the foreground until Ctrl-C.

flute-webhooks-cli listen --forward-to http://127.0.0.1:3000/webhook

Global flags (accepted on every subcommand)

--profile <sandbox|production>
--debug
--output table|json

--output json works on every CLI subcommand, producing pretty-printed JSON for piping into jq. Use --output json >> output.json to save output to a file.

Every documented Webhook API call is reachable from both TUI and CLI:

Pass --debug to log every HTTP request and response (status, URL, body):

flute-webhooks-cli --debug auth token   # traces print to stdout
flute-webhooks-cli --debug tui          # traces go to ~/.flute/flute-webhooks-cli.log

For non-TUI commands, traces print to stdout so you can pipe them through jq or grep. For the TUI, stdout is owned by the terminal renderer, so traces are appended to ~/.flute/flute-webhooks-cli.log. Open a second terminal and run tail -f ~/.flute/flute-webhooks-cli.log to watch live.

Response bodies are logged in full with no truncation, so server stack traces are captured intact. The bearer token is never logged.

Without --debug, default tracing is INFO/WARN. Non-TUI commands write to stderr; the TUI writes to the log file.

MIT.