CLI

Receive webhooks on localhost, send test events and replay failed deliveries.

npm install -g relay-cli
relay login

relay login opens the dashboard in your browser and stores a restricted key for the CLI in ~/.config/relay.

Forward webhooks to your machine

relay listen --forward-to localhost:3000/webhooks

The CLI opens a connection to Relay and forwards every test-mode event to your local server, signed with a session secret it prints when it starts. Add --events invoice.*,customer.created to forward only some types.

The CLI connects out to Relay, so your laptop needs no public URL. Test-mode events come down that connection and the CLI posts them to your local server.

Send a test event

relay events send invoice.paid --data '{"invoice_id": "inv_123", "amount": 4900}'

Replay deliveries

relay deliveries list --status failed --since 24h
relay deliveries replay dlv_8Hc1Rm

Commands

Command	Does
relay listen	Forwards webhooks to a local URL.
relay events send <type>	Sends an event.
relay events get <id>	Shows an event and its deliveries.
relay deliveries list	Lists deliveries, filtered by --status, --endpoint and --since.
relay deliveries replay <id>	Sends a delivery again, as a new attempt.
relay endpoints list	Lists endpoints and their subscriptions.