Commands
Every beam subcommand, its flags, and what it does.
The CLI is a small kong command tree. There are two leaf commands under
webhook, plus the top-level version flag.
beam <command> [flags]
webhook listen <name> Listen for webhooks and replay them to a local URL.
webhook send <name> Send a delivery to a beam hub (reuses server/key from config).
--version Print version and exit.
--help Show context-sensitive help.beam webhook listen <name>
Open a WebSocket to the beam server, claim <name>, and replay every incoming
delivery to a local URL (or print it with --tail). Full details in
Listen & forward.
beam webhook listen myhook --forward http://localhost:3000
beam webhook listen myhook --tail --body-only | jq .event| flag | env | default | meaning |
|---|---|---|---|
--forward | BEAM_FORWARD | http://localhost:3000 | local URL to replay requests to |
--server | BEAM_SERVER | — (required) | your beam deployment's base URL |
--token | BEAM_TOKEN | — | API token (required) |
--key | BEAM_KEY | — | optional per-webhook delivery secret (?key=…) |
--tail | false | print requests to stdout instead of forwarding | |
--body-only | false | with --tail, print only the request body | |
--insecure | false | skip TLS verify (local dev) |
beam webhook send <name>
Fire a single delivery at a hub, reusing server and key from your
config file. Needs no token (the delivery side
is open). Full details in Send.
beam webhook send myhook -d '{"event":"order.created"}'
beam webhook send myhook --path /github/callback -X PUT -d @body.json| flag | env | default | meaning |
|---|---|---|---|
--server | BEAM_SERVER | — (required) | your beam deployment's base URL |
--key | BEAM_KEY | — | delivery secret, sent as ?key=… if required |
-X, --method | POST | HTTP method | |
-d, --data | — | body; @file reads a file, @-/- reads stdin | |
-H, --header | — | extra Name: Value header (repeatable) | |
--path | — | sub-path appended to the hook | |
--query | — | raw query string (id=7&x=1) | |
--insecure | false | skip TLS verify (local dev) |
Configuration precedence
For every flag with an env var or config-file equivalent:
explicit flag / env var > config file > built-in defaultSee Config file for the recognized keys.