Skip to content

Quickstart

This walks you from nothing to a live webhook captured in the cloud and forwarded to your local server. It takes about five minutes.

  1. Create an account and an endpoint.

    Sign in at dashboard.catchbin.io and create an endpoint. Give it a slug (for example stripe-dev) and pick the provider. You get a permanent URL in this shape:

    https://hooks.catchbin.io/wk_<your-workspace>/stripe-dev

    That URL never expires. You configure it in your provider once.

  2. Point a provider at the URL.

    In your provider’s dashboard, add the catchbin URL as a webhook endpoint. For Stripe that is Developers → Webhooks → Add endpoint; for GitHub it is a repository or organization webhook; for Shopify it is a webhook subscription. Paste the signing secret into the catchbin endpoint so catchbin can verify signatures for you.

  3. Trigger an event and watch it land.

    Fire a test event from the provider (Stripe’s Send test webhook, a GitHub push, a Shopify test notification). catchbin answers the provider in a few milliseconds and stores the request. Open the endpoint in the dashboard and you’ll see the event with its headers, body, and signature-verification result.

  4. Install the CLI.

    Terminal window
    brew install catchbin/tap/catchbin

    Other install methods are on the Install page. Then authenticate:

    Terminal window
    catchbin configure

    This prompts for a workspace API key (created in the dashboard). Input is hidden and the key is written to your config file, never echoed.

  5. Forward captured webhooks to localhost.

    Terminal window
    catchbin forward wk_<your-workspace>/stripe-dev localhost:3000

    The CLI holds a persistent connection to catchbin. Every captured event is re-sent to your local server, and the response code and latency print in your terminal. Events that arrived while the CLI was offline are delivered in order when you connect.

  • Verify signatures — read the diagnostic when a signature does not verify.
  • Replay an event — re-send a captured event after you fix a bug.
  • Concepts — the vocabulary behind endpoints, events, and modes.