Skip to content

Commit ce9c455

Browse files
committed
Update docs
1 parent 36bb5d8 commit ce9c455

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

docs/alternative-to/localtunnel.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Webhook.site as a Localtunnel alternative
2+
3+
With Webhook.site CLI, you can easily forward requests to your Webhook.site URL to a local endpoint, or even another endpoint that's behind a firewall.
4+
5+
To get started, install Webhook.site CLI (`whcli`) via NPM or Docker, and follow the examples. If you're a Webhook.site subscriber, you'll also need an API key.
6+
7+
1. To install via NPM: `npm install -g @webhooksite/cli`
8+
2. Now you should be able to run `whcli`
9+
3. To create the tunnel, use the following command:
10+
```shell
11+
whcli forward --token=abc-123 --api-key=def-456 --target=https://localhost:8080
12+
```
13+
14+
Where `token` is your Webhook.site URL ID (e.g. if your Webhook.site URL `webhook.site/abc-123`, your token ID is `abc-123`.)
15+
16+
If you are a free Webhook.site user, you do not need the `--api-key` flag.
17+
18+
To read more about Webhook.site CLI, for example how to handle self-signed certificates, [go here](/cli.html).

docs/alternative-to/ngrok.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Webhook.site as an ngrok alternative
2+
3+
With Webhook.site CLI, you can easily forward requests to your Webhook.site URL to a local endpoint, or even another endpoint that's behind a firewall.
4+
5+
To get started, install Webhook.site CLI (`whcli`) via NPM or Docker, and follow the examples. If you're a Webhook.site subscriber, you'll also need an API key.
6+
7+
1. To install via NPM: `npm install -g @webhooksite/cli`
8+
2. Now you should be able to run `whcli`
9+
3. To create the tunnel, use the following command:
10+
```shell
11+
whcli forward --token=abc-123 --api-key=def-456 --target=https://localhost:8080
12+
```
13+
14+
Where `token` is your Webhook.site URL ID (e.g. if your Webhook.site URL `webhook.site/abc-123`, your token ID is `abc-123`.)
15+
16+
If you are a free Webhook.site user, you do not need the `--api-key` flag.
17+
18+
To read more about Webhook.site CLI, for example how to handle self-signed certificates, [go here](/cli.html).

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,4 +345,10 @@ When you mark a domain as default, 2 things happen:
345345
1. The custom domain is shown in the Webhook.site interface, e.g. when copying a URL
346346
2. The custom domain is used for email sending with the Send Email action
347347

348-
Any existing URLs will continue to work with no change.
348+
Any existing URLs will continue to work with no change.
349+
350+
## What are some tools Webhook.site is a great alternative to?
351+
352+
- [Zapier](/alternative-to/zapier.html) for Webhook testing and workflow and automation building
353+
- [Ngrok](/alternative-to/ngrok.html) for creating local tunnels and proxies
354+
- [Localtunnel](/alternative-to/localtunnel.html) for creating local tunnels and proxies

0 commit comments

Comments
 (0)