You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.markdown
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@ title: API
3
3
order: 10
4
4
---
5
5
6
-
The API doesn't require documentation and is relatively easy to use. At its core, Webhook.site takes your data (HTTP requests) and shows it back to you, and also letting you execute various actions based on the contents.
6
+
The API doesn't require authentication and is relatively easy to use.
7
+
8
+
At its core, Webhook.site takes your data (HTTP requests) and shows it back to you, and also letting you execute various actions based on the contents.
7
9
8
10
## 1 Tokens
9
11
@@ -52,11 +54,11 @@ A token is a container for requests. You can create as many as you want. They ex
52
54
53
55
*Request*
54
56
55
-
*See **POST**`/token`*
57
+
[*See **POST**`/token`*](#11-create-token)
56
58
57
59
*Response*
58
60
59
-
*See **POST**`/token`*
61
+
[*See **POST**`/token`*](#11-create-token)
60
62
61
63
### 1.3 Set password [P]
62
64
@@ -66,11 +68,13 @@ A token is a container for requests. You can create as many as you want. They ex
66
68
67
69
*Request*
68
70
69
-
*See **POST**`/token`*
71
+
```json
72
+
{"password": "hunter2"}
73
+
```
70
74
71
75
*Response*
72
76
73
-
*See **POST**`/token`*
77
+
[*See **POST**`/token`*](#11-create-token)
74
78
75
79
### 1.4 Set alias [P]
76
80
@@ -80,19 +84,21 @@ A token is a container for requests. You can create as many as you want. They ex
80
84
81
85
*Request*
82
86
83
-
*See **POST**`/token`*
87
+
```json
88
+
{"alias": "my-webhook"}
89
+
```
84
90
85
91
*Response*
86
92
87
-
*See **POST**`/token`*
93
+
[*See **POST**`/token`*](#11-create-token)
88
94
89
95
### 1.5 Get token
90
96
91
97
**GET**`/token/:id`
92
98
93
99
*Response*
94
100
95
-
*See **POST**`/token`*
101
+
[*See **POST**`/token`*](#11-create-token)
96
102
97
103
### 1.6 Delete token
98
104
@@ -106,9 +112,9 @@ A token is a container for requests. You can create as many as you want. They ex
106
112
107
113
### 2.1 Create request
108
114
109
-
****(any method)***`/:tokenId`
110
-
****(any method)***`/:tokenId/:statusCode`
111
-
****(any method)***`/:tokenId/(anything)`
115
+
***(any method)***`/:tokenId` <br>
116
+
***(any method)***`/:tokenId/:statusCode` <br>
117
+
***(any method)***`/:tokenId/(anything)`
112
118
113
119
This request will be stored as a *request*.
114
120
@@ -206,7 +212,7 @@ Takes `?password=` parameter.
206
212
207
213
**GET**`/token/:id/request/:id/raw`
208
214
209
-
Outputs the request as a response (body, content-type.)
215
+
Returns the request as a response (body, content-type.)
0 commit comments