Skip to content
HookNexus

Quick Start

This guide takes you from zero to a fully working webhook endpoint in under 5 minutes.

Prerequisites

  • A modern web browser (Chrome, Firefox, Safari, or Edge)
  • A GitHub account (sign-in is GitHub OAuth only)

Steps

  1. Create an account

    Go to hooknexus.com and click Sign In. Complete GitHub OAuth in the browser to create or access your account.

  2. Create an endpoint

    Once logged in, you’ll land on the Dashboard. Click New Endpoint to generate a unique webhook URL.

    Your new endpoint URL looks like:

    https://api.hooknexus.com/h/a1b2c3d4-e5f6-7890-abcd-ef1234567890

  3. Copy the URL

    Click the copy button next to the URL. You’ll use this to send a test request.

  4. Send a test request

    Open a terminal and run:

    Terminal window
    curl -X POST https://api.hooknexus.com/h/YOUR_ENDPOINT_ID \
      -H "Content-Type: application/json" \
      -d '{"event":"test","message":"Hello HookNexus!"}'

    Replace YOUR_ENDPOINT_ID with the ID from step 3.

  5. View the request

    Switch back to the HookNexus dashboard. Your test request appears instantly in the left panel. Click on it to inspect:

    • Method — POST
    • Headers — Content-Type, User-Agent, etc.
    • Body — Your JSON payload with syntax highlighting

  6. Forward webhooks to your machine (CLI)

    To pipe live traffic into a local HTTP server, install the official CLI (source on GitHub) and run a forward tunnel (available on Free and Plus):

    Terminal window
    npm install -g hooknexus
    hooknexus login
    hooknexus forward --to http://localhost:PORT/PATH

    Replace PORT and PATH with the port and route on your machine that should receive the forwarded HTTP request (full URL, not just the origin—see Local forwarding). With one endpoint, the CLI usually picks it automatically; otherwise pass your endpoint id. Keep the process running and start your local app. See Local forwarding for --preserve-path, --allow-external, and security notes.

What’s Next?

Now that you’ve captured your first webhook, explore these topics: