diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-01-19 13:55:40 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-01-19 19:06:48 +0000 |
| commit | cddaefd9420507318d71f56355ff5a6648dcd951 (patch) | |
| tree | cf196ef12c36fdb0502b5ebf0f722ab32de8e2c0 /docs | |
| parent | 64f24acb9a1835ea7f0bec241c233c3e4a202d46 (diff) | |
| download | karakeep-cddaefd9420507318d71f56355ff5a6648dcd951.tar.zst | |
feat: Change webhooks to be configurable by users
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/03-configuration.md | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/docs/docs/03-configuration.md b/docs/docs/03-configuration.md index bf326aff..2ff8ff25 100644 --- a/docs/docs/03-configuration.md +++ b/docs/docs/03-configuration.md @@ -98,18 +98,15 @@ Hoarder uses [tesseract.js](https://github.com/naptha/tesseract.js) to extract t ## Webhook Configs -You can use webhooks to trigger actions when bookmarks are changed ( only support _crawled_ now ). +You can use webhooks to trigger actions when bookmarks are created, changed or crawled. | Name | Required | Default | Description | | ------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -| WEBHOOK_URLS | No | | The urls of the webhooks to trigger, separated by commas. | -| WEBHOOK_TOKEN | No | | The token to use for authentication. Will appears in the Authorization header as Bearer token. | | WEBHOOK_TIMEOUT_SEC | No | 5 | The timeout for the webhook request in seconds. | | WEBHOOK_RETRY_TIMES | No | 3 | The number of times to retry the webhook request. | :::info -- If a url is add to hoarder , after it is crawled, the webhook will be triggered. - The WEBHOOK_TOKEN is used for authentication. It will appear in the Authorization header as Bearer token. ``` Authorization: Bearer <WEBHOOK_TOKEN> @@ -118,7 +115,7 @@ You can use webhooks to trigger actions when bookmarks are changed ( only suppor ```json { - "jobId": 123, + "jobId": "123", "type": "link", "bookmarkId": "exampleBookmarkId", "userId": "exampleUserId", |