Update details for webhooks.

firefly-iii · Jan 29, 2021 · d452990 · d452990
1 parent f7d0bc2
commit d452990
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/yaml/paths/webhooks.yaml b/yaml/paths/webhooks.yaml
@@ -79,7 +79,7 @@
     tags:
       - webhooks
     description: Update existing webhook.
-    summary: Update an existing webhook's information.
+    summary: Update an existing webhook's information. If you wish to reset the secret, submit any value as the "secret". Firefly III will take this as a hint and reset the secret of the webhook.
     parameters:
     - in: path
       name: id

diff --git a/yaml/schemas/Webhook.yaml b/yaml/schemas/Webhook.yaml
@@ -32,8 +32,8 @@ Webhook:
       type: string
       format: string
       example: "iMLZLtLx2JHWhK9Dtyuoqyir"
-      readOnly: true
-      description: A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook.
+      readOnly: false
+      description: A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted.
     trigger:
       type: string
       format: string