Skip to content

Commit 01d7333

Browse files
committed
API docs fixes
1 parent c440c65 commit 01d7333

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

docs/api.markdown

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: API
33
order: 10
44
---
55

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.
79

810
## 1 Tokens
911

@@ -52,11 +54,11 @@ A token is a container for requests. You can create as many as you want. They ex
5254

5355
*Request*
5456

55-
*See **POST** `/token`*
57+
[*See **POST** `/token`*](#11-create-token)
5658

5759
*Response*
5860

59-
*See **POST** `/token`*
61+
[*See **POST** `/token`*](#11-create-token)
6062

6163
### 1.3 Set password [P]
6264

@@ -66,11 +68,13 @@ A token is a container for requests. You can create as many as you want. They ex
6668

6769
*Request*
6870

69-
*See **POST** `/token`*
71+
```json
72+
{"password": "hunter2"}
73+
```
7074

7175
*Response*
7276

73-
*See **POST** `/token`*
77+
[*See **POST** `/token`*](#11-create-token)
7478

7579
### 1.4 Set alias [P]
7680

@@ -80,19 +84,21 @@ A token is a container for requests. You can create as many as you want. They ex
8084

8185
*Request*
8286

83-
*See **POST** `/token`*
87+
```json
88+
{"alias": "my-webhook"}
89+
```
8490

8591
*Response*
8692

87-
*See **POST** `/token`*
93+
[*See **POST** `/token`*](#11-create-token)
8894

8995
### 1.5 Get token
9096

9197
**GET** `/token/:id`
9298

9399
*Response*
94100

95-
*See **POST** `/token`*
101+
[*See **POST** `/token`*](#11-create-token)
96102

97103
### 1.6 Delete token
98104

@@ -106,9 +112,9 @@ A token is a container for requests. You can create as many as you want. They ex
106112

107113
### 2.1 Create request
108114

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)`
112118

113119
This request will be stored as a *request*.
114120

@@ -206,7 +212,7 @@ Takes `?password=` parameter.
206212

207213
**GET** `/token/:id/request/:id/raw`
208214

209-
Outputs the request as a response (body, content-type.)
215+
Returns the request as a response (body, content-type.)
210216

211217
### 2.5 Delete request
212218

0 commit comments

Comments
 (0)