Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 2.42 KB

README.md

File metadata and controls

98 lines (67 loc) · 2.42 KB
Raw

UseWebhook CLI

UseWebhook is a free tool to capture webhooks from your browser.

  • ⚡️ Test webhooks without a server
  • 🔍 Inspect and diff incoming requests
  • 👨‍💻 Forward to localhost, or replay from history
  • ✅ Debug webhooks from Stripe, Paddle, Slack, or anywhere else

No sign up required. Just send HTTP requests to your webhook URL.

Installation

The easiest way to install is using the automated script:

curl -sSL https://usewebhook.com/install.sh | bash

It will detect your OS and architecture, download the corresponding executable, and add it to your PATH.

Alternatively, you can download the binary for your operating system from the releases page, or build from source if you'd like.

Usage

Create a new webhook and start listening:

$ usewebhook

> Dashboard: https://usewebhook.com/?id=123
> Webhook URL: https://usewebhook.com/123

Listen for requests to a specific webhook:

$ usewebhook <webhook-URL>

Forward incoming requests to localhost:

$ usewebhook <webhook-URL> --forward-to http://localhost:8080/your-endpoint

Replay a specific request from the webhook's history:

$ usewebhook <webhook-URL> --request-id <request-ID> -f http://localhost:8080/your-endpoint

Build from source

  1. Ensure you have Go installed on your system.
  2. Clone the repository: 
    git clone https://github.com/anthonynsimon/usewebhook-cli
  3. Navigate to the project directory: 
    cd usewebhook-cli
  4. Build the binary: 
    go build -o usewebhook
  5. Move the binary to your PATH: 
    sudo mv ./usewebhook /usr/local/bin/

Contributing

Contributions are welcome! In case you want to add a feature, please create a new issue and briefly explain what the feature would consist of.

Simply follow the next steps:

  • Fork the project.
  • Create a new branch.
  • Make your changes and write tests when practical.
  • Commit your changes to the new branch.
  • Send a pull request, it will be reviewed shortly.

Change log

Note: Breaking changes might happen until v1.0.0 is reached

  • 0.2.2: Doc improvements
  • 0.2.1: CLI usage improvements
  • 0.2.0: Consistent CLI argument names
  • 0.1.0: Initial release

License

This project is licensed under the MIT License. See the LICENSE file for details.