beam
Getting Started

Getting Started

Install the beam CLI, point it at a hub, and forward your first webhook to localhost.

The shortest path from zero to a working beam tunnel is three steps:

  1. Install the CLI binary.
  2. Drop your token and server in a config file.
  3. Run beam webhook listen <name> and POST to the public URL.

There is no account to set up beyond your own Cloudflare one (and only the person deploying the edge needs that). If a beam hub is already deployed, the CLI is all you need — point it at the server with your token and start receiving traffic.

beam webhook listen myhook --forward http://localhost:3000
# → any POST to https://beam.example.com/webhook/myhook is replayed to localhost:3000

When you want to deploy your own edge instead of using a shared one, see Deploy your own. When you want to re-fire deliveries by hand while debugging a listener, see Send.