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: README.md
+30
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,36 @@ It can be read-only or with edit right. With edit-right, user can do anything as
56
56
57
57
This is the main reason I've started to develop this app.
58
58
59
+
### Webhook
60
+
61
+
You can register webhook listeners on folders and receive an HTTP notification when one of these event occurs:
62
+
63
+
-`create` occurs when a directory is created
64
+
-`upload` occurs when an item is uploaded
65
+
-`rename` occurs when an item is renamed
66
+
-`delete` occurs when an item is deleted
67
+
-`start` occurs when fibr start and do something on an item
68
+
-`access` occurs when content is accessed (directory browsing or just one file)
69
+
70
+
The request sends is a POST with 15s timeout with the given payload structure:
71
+
72
+
```json
73
+
{
74
+
"item": {
75
+
"date": "2021-08-10T19:31:28.952325533Z",
76
+
"name": "payload.json",
77
+
"pathname": "/path/to/payload.json",
78
+
"isDir": false,
79
+
"size": 177
80
+
},
81
+
"type": "upload"
82
+
}
83
+
```
84
+
85
+
It will contains an extra key `new` with the same structure of `item` in case of a `rename` event.
86
+
87
+
The webhook can be recursive (all children folders will be notified too) and for now, no event type selection is possible: the webhook will receive all kinds of events.
88
+
59
89
### SEO
60
90
61
91
Fibr provides [OpenGraph metadatas](https://ogp.me) to have nice preview of link when shared. These metadatas don't leak any password-protected datas.
0 commit comments