Skip to content
Ricochet docs

Quickstart

This takes a provider’s webhook from a Ricochet URL to a server on your machine. You need an account (sign-up is by invite during the alpha) and a local server that accepts POST requests, here on http://localhost:3000/webhooks.

  1. Sign in to the dashboard. Open app.getricochet.dev and sign in with the link we email you. Your first project starts with a dev environment, and the first-run screen walks through the next three steps.

  2. Create a source. A source is the URL a provider sends to. Pick the sender (Stripe, GitHub, generic HMAC or “not listed”) and copy the URL, which looks like https://in.getricochet.dev/src_….

  3. Point the provider at it and set its secret. Paste the URL where the provider asks for a webhook endpoint, then copy the provider’s signing secret into the source, so Ricochet can check every request. The provider guides say where each provider keeps it.

  4. Install the CLI. A single binary for Linux, macOS and Windows (from Git Bash); the script checks its checksum and puts it in ~/.local/bin:

    Terminal window
    curl -fsSL https://getricochet.dev/install.sh | sh

    The builds are also at /download/latest/.

  5. Sign in from the CLI. This opens the browser; confirm the code shown in the terminal.

    Terminal window
    ricochet login

  6. Forward events to your app.

    Terminal window
    ricochet listen --forward localhost:3000/webhooks

    The CLI connects your own CLI destination to the environment’s sources and shows each event as it arrives, with your server’s status and latency. It saves the target in .ricochet.json, so next time ricochet listen is enough.

  7. Send an event. Trigger one from the provider, or send a signed sample:

    Terminal window
    ricochet trigger stripe invoice.paid

If your handler fails, fix it and send the same event again. In the full-screen view, select the event and press r, or:

Terminal window
ricochet replay evt_…

Next steps

Section titled “Next steps”