Skip to content

Commit e1900e4

Browse files
authored
Merge pull request #47 from Infinity585/Documentation-added
Update API.md
2 parents 443a64e + ae65444 commit e1900e4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/API.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,23 @@ These endpoints are used by the Rust+ Companion App.
1414

1515
Redirects to the Profile Image for the SteamId.
1616

17+
### `/api/history/read`
18+
19+
- Method: `POST`
20+
- Headers:
21+
- `Content-Type`: `application/json`
22+
- Body: `AuthToken`
23+
24+
Response contains event history, such as Player Deaths and Server Pair Requests.
25+
26+
- Notification ID
27+
- Notification Date
28+
- Player SteamId
29+
- Server ID
30+
- Title (eg `{name} is online`)
31+
- Body (server name)
32+
- Data (event data)
33+
1734
### TODO
1835

1936
Endpoints that haven't been documented yet.

0 commit comments

Comments
 (0)