Skip to content

Docs / Get started

Get started

In about five minutes you'll have a webhook URL, see your first webhook arrive, read it in full, forward it to a server or your laptop, and send it again.

Try it without an account

Open webhookhq.dev/new and click Create a bin. You get an instant bin:

  • a capture URL like https://in.webhookhq.dev/b/k3x9p2q7m4 to paste into Stripe, GitHub or anything that sends webhooks,
  • a viewer URL to open the bin again, and a token. Copy the token: it's shown once, and other browsers ask for it.

A bin takes 100 webhooks a day and is deleted with its events after 7 days. For URLs that last, forwarding and replay, sign up.

Sign up and create an endpoint

  1. Sign up at app.webhookhq.dev/sign-up with your email and a password, or with GitHub. Free needs no card.
  2. On Set up your organization, give your organization a name (usually your company or team) and say who'll use WebhookHQ. You can skip this and change it later.
  3. You land in the Default workspace. Click New endpoint, name it after what sends to it ("Stripe test"), and click Create endpoint.

Your endpoint's URL starts with your organization:

https://in.webhookhq.dev/acme/acme-stripe-test

On Free the last part is random, like k3x9p2q7m4. Developer and above can choose it. Click Copy URL at the top of the endpoint's page.

Send a test webhook

The empty endpoint page says Waiting for the first webhook and shows a command to try. Run it in your terminal:

curl -X POST https://in.webhookhq.dev/acme/acme-stripe-test \
  -H "Content-Type: application/json" \
  -d '{"type": "test.event", "hello": "world"}'

WebhookHQ answers 200 straight away, and the webhook appears on the page within about two seconds. You don't need to refresh.

For a real one, paste the URL into a provider: in Stripe, add it as a webhook endpoint and send a test invoice.paid; in GitHub, add it under the repository's Settings → Webhooks and GitHub sends a ping.

On Pro and above, Send test event on the endpoint's page sends a realistic Stripe, GitHub or Shopify event signed with your secret. See Signatures.

Inspect it

Click the webhook in the list. You see its method, path, sender (Stripe, GitHub), size, time and sender's IP address, and tabs for:

  • Body: JSON and XML pretty-printed and as a tree, or the raw body exactly as sent.
  • Headers and Query, and Form for form-encoded bodies.

Copy as cURL and Copy as fetch turn it into a command with the original headers and body. Use the search box to find events by id, type, path or body, or a JSONPath like $.data.object.customer == "cus_123". More in Endpoints.

Forward it

To a server: on the endpoint's page, click Settings, then under Forwarding enter a Destination URL such as https://api.acme.dev/webhooks/stripe and click Start forwarding. Every new webhook is sent there with the same method, headers and body, and failures are retried. See Forwarding.

To your laptop: install the CLI, create a token on the Access tokens tab, then:

whq login
whq listen 3000 --endpoint acme-stripe-test

Each new webhook arrives at http://localhost:3000, and what your app answers shows in the terminal and in the event's deliveries.

Replay it

Fixed a bug? Send the same webhook again:

  • Send to my tunnel on the event, while whq listen runs, sends it to your app unchanged.
  • Edit and send lets you change the method, path, headers or body and send it to a destination, any public URL or your tunnel.
  • From the terminal: whq replay 3f9a2c1 3000, with the event's short id.

Replays show in the event's deliveries with your server's answer, and they don't count towards your plan's events. See Replay.

Next steps