Skip to content

Commit c185441

Browse files
committed
Docs tweaks
1 parent 781b2cd commit c185441

File tree

2 files changed

+56
-50
lines changed

2 files changed

+56
-50
lines changed

docs/custom-actions.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ nav_order: 400
88
<a href="/images/custom-actions.png">
99
![Custom Actions editor screenshot](/images/custom-actions.png)</a>
1010

11-
With Custom Actions, it is possible to create a workflow out of a set of actions that are executed whenever a Webhook.site URL receives a request or email.
11+
With Custom Actions, it is possible to create a workflow out of a set of actions that are executed whenever a Webhook.site URL receives a request or email. Custom Actions run on the Webhook.site Cloud.
1212

1313
Using this functionality, you can connect APIs that aren't compatible, convert a HTTP request to an email or vice versa, build workflows that would otherwise require a developer, and much, much more.
1414

15-
The general principle of Custom Actions is that they are always executed in a chain. As they run, [Variables](/custom-actions/variables.html) are exchanged between them.
15+
The general principle of Custom Actions is that they are always executed in a chain. As they run, [Variables](/custom-actions/variables.html) are exchanged between them.
1616

1717
Additionally, the [Conditions](/custom-actions/action-types.html#conditions) action can define certain conditions that are used to decide whether specific actions run or not.
1818

@@ -21,7 +21,7 @@ Even though actions are run in a chain, it's still possible to branch out and ru
2121
On each request, the output for all the different actions is collected so you can go back and see what happened. If the action sends HTTP Requests, both the request and response details are shown.
2222

2323
<figure markdown="span">
24-
![Extract JSON in action](/images/kCuUKnGNu1NNGv4j7Y3UXTyV.png){ width="300" }
24+
![Extract JSON in action](/images/kCuUKnGNu1NNGv4j7Y3UXTyV.png){ width="700" }
2525
<figcaption>Action output shown on individual requests along with HTTP Request data</figcaption>
2626
</figure>
2727

@@ -30,7 +30,7 @@ If actions fail, the request they ran on is marked. It is possible to set up [no
3030
With [Replay](/custom-actions.html#replay), it's possible to run the actions again, e.g. for actions that failed previously.
3131

3232
<figure markdown="span">
33-
![Extract JSON in action](/images/ZxJHuOqDle5GG5kzDyc2WyPt.png){ width="300" }
33+
![Extract JSON in action](/images/ZxJHuOqDle5GG5kzDyc2WyPt.png){ width="700" }
3434
<figcaption>Error Log is a convenient way to monitor Schedules and Custom Actions</figcaption>
3535
</figure>
3636

@@ -75,7 +75,7 @@ You can then use this template by creating an *Import Template* action.
7575

7676
### Creating a Template
7777

78-
To create a Template, click the *Create Template* button at the bottom of the Custom Actions overlay. Then enter a name for the template and select which actions should be copied to the template. If your template actions e.g. depend on variables pre-existing, like configuration data, you can add one or more Predefined Variables. These are available to the actions in the Template, but also to any subsequent actions coming after the Import Template action.
78+
To create a Template, click the *Create Template* button in the Custom Actions editor. Then enter a name for the template and select which actions should be copied to the template. If your template actions e.g. depend on variables pre-existing, like configuration data, you can add one or more Predefined Variables. These are available to the actions in the Template, but also to any subsequent actions coming after the Import Template action.
7979

8080
Predefined Variables can be updated in the Control Panel.
8181

docs/index.md

Lines changed: 51 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,27 @@ nav_order: 50
55

66
# Webhook.site Frequently Asked Questions
77

8-
## What is a "webhook"?
8+
## What is a webhook?
99

10-
The term '[webhook](https://en.wikipedia.org/wiki/Webhook)' refers to the general technology of how Web-based systems talk to each other.
10+
The term '[webhook](https://en.wikipedia.org/wiki/Webhook)' refers to a general method of how Web-based systems talk to each other.
1111

12-
In short, many systems (for example, a payment platform and a customer management system) communicate with each other by sending Web requests back and forth, for example, from `https://paymentsys.example` to `https://customersys.example/register-payment` and vice-versa.
12+
In short, many systems (for example, a payment platform and a customer management system) communicate with each other by sending Web requests back and forth, for example, from `https://paymentsys.com` to `https://customersys.com/order-created` and vice-versa.
1313

14-
[More about webhooks](https://simonfredsted.com/1583).
14+
[In-depth article about webhooks](https://simonfredsted.com/1583).
1515

1616
## What is Webhook.site?
1717

1818
Webhook.site is a tool for building software that not only use webhooks but other types of communication, either by allowing developers to inspect the data that's being sent via a webhook, but also helps users create workflows that respond to and interact with webhooks from various systems.
1919

20-
When visiting [Webhook.site](https://webhook.site), users instantly get a free, unique, random URL and e-mail address. Everything that's sent to these addresses are shown instantly. With this, users can test and debug Webhooks and HTTP requests, as well as create workflows using the [Custom Actions](/custom-actions.html) graphical builder or [WebhookScript](/webhookscript.html), a simple scripting language, to transform, validate and process HTTP requests in a variety of ways – without setting up and maintaining your own infrastructure.
20+
When visiting [Webhook.site](https://webhook.site), users instantly get a free, unique, random URL and e-mail address. Everything that's sent to these addresses are shown instantly. With this address, users can test and debug webhooks and HTTP requests.
2121

22-
Webhook.site is a [registered corporation](https://datacvr.virk.dk/enhed/virksomhed/41561718) in Denmark since August 2020.
22+
Additionally, a Webhook.site subscription comes with a [suite of cloud services](https://webhook.site/register) for building Web-based workflows and automations, including Custom Actions, an advanced workflow builder that lets you automate, transform and forward data visually or via scripting languages.
23+
24+
Webhook.site is operated by Webhook ApS, a [registered corporation](https://datacvr.virk.dk/enhed/virksomhed/41561718) in Denmark since August 2020.
2325

2426
### Company information
2527

26-
Webhook.site company stats as of Feburary 2025:
28+
Webhook.site company stats as of Feburary 2025:
2729

2830
- 300.000+ monthly unique users
2931
- 2300+ subscribed customers
@@ -89,6 +91,48 @@ For subscribed customers, URLs associated with an account never automatically ex
8991

9092
For free users, the URL – and its data – is automatically removed after 7 days.
9193

94+
## How do I export the data stored on Webhook.site?
95+
96+
With a [Webhook.site subscription](pro.markdown), there's a variety of different ways to export data sent to your URL or email address.
97+
98+
1. Custom Actions can be used in a variety of ways to export data. Below are listed a few examples of actions that could be used. [More info here](/custom-actions/action-types.html).
99+
* [Database Query](/custom-actions/action-types.html#database-query)
100+
* [HTTP Request](/custom-actions/action-types.html#http-request)
101+
* [Run SSH Command](/custom-actions/action-types.html#run-ssh-command)
102+
* [Amazon Web Services S3](/custom-actions/action-types.html#s3)
103+
* [Dropbox](/custom-actions/action-types.html#dropbox)
104+
105+
1. Webhook.site provides a CSV Export functionality, simply click the button in the menu to download all data as a CSV file.
106+
107+
![CSV Export](/images/csv-export.png)
108+
109+
2. Data can be retrieved and saved using the [Webhook.site API](api/tokens.md#get-requests) using any programming language.
110+
111+
3. With the Webhook.site CLI (Command-Line Interface), requests can be forwarded directly from Webhook.site to a local workstation or server. [More info here](cli.md)
112+
113+
## How do I forward webhook requests?
114+
115+
To forward incoming requests to another address, use Webhook.site [Custom Actions](/custom-actions.html) to create a *HTTP Request* action. Running on the Webhook.site Cloud, when set to the *forward* mode, all data is automatically forwarded to the specified URL.
116+
117+
## How do I send data to my computer/localhost?
118+
119+
There's several ways to accomplish this depending on your needs.
120+
121+
1. You can periodically fetch the data using the [Webhook.site API](api/tokens.md#get-requests)
122+
123+
2. Requests can also be streamed to a local URL using the [Webhook.site CLI](cli.md), in a similar fashion to e.g. ngrok.
124+
125+
3. Webhook.site also supports the XHR Redirect feature, which uses your browser in order to forward the requests. The endpoint will need to respond with CORS headers in all requests so that the browser will be able to send requests to it. The forwarding will only work as long as the browser window is open.
126+
127+
The following CORS headers should allow Webhook.site to forward requests to your local endpoint via XHR Redirect:
128+
129+
```
130+
Access-Control-Allow-Origin: *
131+
Access-Control-Allow-Methods: *
132+
Access-Control-Allow-Headers: *
133+
Access-Control-Expose-Headers: Content-Length,Content-Range
134+
```
135+
92136
## How can I automatically remove data from Webhook.site?
93137

94138
Many businesses have strict requirements on the amount of data that can be stored by third-party companies, and Webhook.site provides full flexibility to handle these data protection and security requirements by limiting the amount of data stored on the Webhook.site Cloud.
@@ -236,44 +280,6 @@ After, with the JSON Escape Variable Modifier:
236280
}
237281
```
238282

239-
## How do I export the data stored on Webhook.site?
240-
241-
With a [Webhook.site subscription](pro.markdown), there's a variety of different ways to export data sent to your URL or email address.
242-
243-
1. Custom Actions can be used in a variety of ways to export data. Below are listed a few examples of actions that could be used. [More info here](/custom-actions/action-types.html).
244-
* [Database Query](/custom-actions/action-types.html#database-query)
245-
* [HTTP Request](/custom-actions/action-types.html#http-request)
246-
* [Run SSH Command](/custom-actions/action-types.html#run-ssh-command)
247-
* [Amazon Web Services S3](/custom-actions/action-types.html#s3)
248-
* [Dropbox](/custom-actions/action-types.html#dropbox)
249-
250-
1. Webhook.site provides a CSV Export functionality, simply click the button in the menu to download all data as a CSV file.
251-
252-
![CSV Export](/images/csv-export.png)
253-
254-
2. Data can be retrieved and saved using the [Webhook.site API](api/tokens.md#get-requests) using any programming language.
255-
256-
3. With the Webhook.site CLI (Command-Line Interface), requests can be forwarded directly from Webhook.site to a local workstation or server. [More info here](cli.md)
257-
258-
## How do I send data to my computer/localhost?
259-
260-
There's several ways to accomplish this depending on your needs.
261-
262-
1. You can periodically fetch the data using the [Webhook.site API](api/tokens.md#get-requests)
263-
264-
2. Requests can also be streamed to a local URL using the [Webhook.site CLI](cli.md), in a similar fashion to e.g. ngrok.
265-
266-
3. Webhook.site also supports the XHR Redirect feature, which uses your browser in order to forward the requests. The endpoint will need to respond with CORS headers in all requests so that the browser will be able to send requests to it. The forwarding will only work as long as the browser window is open.
267-
268-
The following CORS headers should allow Webhook.site to forward requests to your local endpoint via XHR Redirect:
269-
270-
```
271-
Access-Control-Allow-Origin: *
272-
Access-Control-Allow-Methods: *
273-
Access-Control-Allow-Headers: *
274-
Access-Control-Expose-Headers: Content-Length,Content-Range
275-
```
276-
277283
## How can I test an IPv6-only request?
278284

279285
If you access Webhook.site with the hostname [https://ipv6.webhook.site](https://ipv6.webhook.site), your URL will only work with IPv6.

0 commit comments

Comments
 (0)