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: content/3.api-v2/1.introduction.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,16 +9,21 @@ Welcome to FreeStuff's second iteration on our api. Api v2 can do everything v1
9
9
- Streamlined the data obtaining process
10
10
- Built on web standards. See [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md), [Problem JSON](https://datatracker.ietf.org/doc/html/rfc7807), and more
11
11
- Introduction of compatibility dates for seamless api versioning
12
-
- Introduction of a free tier. See pricing for more details
| Channels | 100% Discount, Free Weekend, DLCs & More | All Channels, including Prime Gaming |
23
23
| Data | Partial data, no metadata, reduced assets | Full data, see documentation for more details |
24
24
| Interface | Webhooks only | Webhooks + REST Api |
25
+
| Commercial use | Prohibited² | Prohibited² |
26
+
27
+
¹ This price is without guarantee. For the actual binding price please check your dashboard.
28
+
29
+
² There is an additional commercial tier for if you want to use FreeStuff's API or Data in a commercial setting. Please contact us for more information.
Copy file name to clipboardExpand all lines: content/3.api-v2/2.concepts.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,8 @@ Additionally a product has some basic properties like a title, assets (logos, im
13
13
14
14
Each product has a kind as described earlier. This value describes what kind of product it is. Usually it's a **game**, but others like **dlc** or **loot** for game pass or prime gaming are also possible. FreeStuff also has more types like **art**, **ost**, or **other** which are currently unused.
15
15
16
+
The Data Models below show compatibility date `2025-03-01`. Newer versions might differ in details.
Copy file name to clipboardExpand all lines: content/3.api-v2/5.webhooks.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ The message payload (http body) follows the [Standard Webhooks Spec](https://git
9
9
10
10
```jsonc
11
11
{
12
-
"type":"urn:fsb:event:announcement.publish",
12
+
"type":"fsb:event:announcement.publish",
13
13
"timestamp":"2022-11-03T20:26:10.344522Z",
14
14
"data": {
15
15
// ...
@@ -41,6 +41,10 @@ FreeStuff signs every webhook request as per [Standard Webhooks Spec](https://gi
41
41
- Make sure to ignore requests with an old `Webhook-Timestamp` value
42
42
- Make sure to use the payload body `timestamp` field as the contextual timestamp and use the header only for verification
43
43
44
+
::alert{type="info"}
45
+
If you are not using a library to verify the request for you and you are not interested in implementing the verification yourself, we recommend you pick a long and unguessable url for your webhook to prevent abuse.
46
+
::
47
+
44
48
45
49
## Resends
46
50
@@ -67,7 +71,7 @@ FreeStuff attempts to resend failed deliveries as per [Standard Webhooks Spec](h
67
71
68
72
## Event List
69
73
70
-
### urn:fsb:event:ping
74
+
### fsb:event:ping
71
75
72
76
Fired either when the ping button was pressed on your dashboard or periodically to check if your webhook is still operational.
73
77
@@ -80,7 +84,7 @@ The `data` field will contain the following object:
80
84
```
81
85
82
86
83
-
### urn:fsb:event:announcement_published
87
+
### fsb:event:announcement-created
84
88
85
89
Fired when a new announcement is published.
86
90
@@ -89,7 +93,7 @@ The `data` field will contain a single `ResolvedAnnouncement`. Check it's `resol
89
93
:data-model{name="ResolvedAnnouncement"}
90
94
91
95
92
-
### urn:fsb:event:product_updated
96
+
### fsb:event:product-updated
93
97
94
98
Fired when a previously published product is updated.
0 commit comments