healthcheck example

docs/markdown/contrib.md

@@ -9,6 +9,7 @@ This amazing people helped the project!
 - @david-boles - Docs.
 - @SebDanielsson - Brew.
 - @n194 - AUR Package.
+- @Zottelchen - Healthchecks example.
 - @jin-park-dev - Typos.
 - @sumnerboy12 - Typos.
 - @FuzzyMistborn - Typos.

docs/markdown/examples.md

@@ -14,4 +14,27 @@ This can come in handy if a backup process crashed or if it was accidentally can
 autorestic exec -b my-backend -- unlock
 ```
 
+## Use hooks to integrate with [healthchecks](https://healthchecks.io/)
+
+> Thanks to @Zottelchen for providing it ❤️
+
+```yaml
+extras:
+  healthchecks: &healthchecks
+    hooks:
+      before:
+        - 'curl -m 10 --retry 5 -X POST -H "Content-Type: text/plain" --data "Starting backup for location: ${AUTORESTIC_LOCATION}" https://<healthchecks-url>/ping/<uid>/start'
+      failure:
+        - 'curl -m 10 --retry 5 -X POST -H "Content-Type: text/plain" --data "Backup failed for location: ${AUTORESTIC_LOCATION}" https://<healthchecks-url>/ping/<uid>/fail'
+      success:
+        - 'curl -m 10 --retry 5 -X POST -H "Content-Type: text/plain" --data "Backup successful for location: ${AUTORESTIC_LOCATION}" https://<healthchecks-url>/ping/<uid>'
+
+locations:
+  something:
+    <<: *healthchecks
+    from: /somewhere
+    to:
+      - somewhere-else
+```
+
 > :ToCPrevNext