Skip to content

docs: add Spooky Particles example to HTTP hooks - #721

Open
n8peace wants to merge 1 commit into
creativeprojects:masterfrom
banana-intelligence-dot-ai:docs-spooky-particles-hooks
Open

n8peace wants to merge 1 commit into
creativeprojects:masterfrom
banana-intelligence-dot-ai:docs-spooky-particles-hooks

Conversation

@n8peace

@n8peace n8peace commented Nov 19, 2026

Copy link
Copy Markdown

This adds a Spooky Particles example to the HTTP hooks page, right after the Watchgoose one and in the same shape.

Spooky Particles ping links take /start, success (the bare link), /fail and /<exit-code>. So the example uses send-before, send-after and send-after-fail, and posts ${ERROR} and ${ERROR_STDERR} as the body of the failure ping. It also mentions /${ERROR_EXIT_CODE} to record restic's exit code.

How I tested it:

  • Every tab (toml, yaml, hcl, json) with resticprofile 0.34.0 and restic 0.20.0: a good backup, and a missing repository (exit 10).
  • The hooks sent HEAD /start, HEAD on success, and POST /fail with the restic error as the body. The ${ERROR_EXIT_CODE} URL sent POST /10.
  • I ran those against a local capture server, then checked the live endpoint accepts the same HEAD and POST requests.
  • go run ./config/checkdoc -r docs/content -i changelog.md reports nothing new.

Disclosure: I'm the founder of Spooky Particles. Happy to keep this example current if anything changes on our side.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The HTTP hooks documentation adds Spooky Particles tags and monitoring configuration examples in TOML, YAML, HCL and JSON.

Changes

Spooky Particles documentation

Layer / File(s) Summary
Document Spooky Particles monitoring
docs/content/configuration/http_hooks.md
The page tags include spookyparticles.com. The examples show start, success and failure hooks, an error-reporting POST body and an exit-code URL alternative.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested labels: documentation

Suggested reviewers: bartekrutkowski, creativeprojects

Merge Risk: Minimal · up to b6ea4

This only adds a documentation example for Spooky Particles monitoring hooks. It does not change resticprofile behavior, and I found no actionable merge-blocking risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: a Spooky Particles example added to the HTTP hooks documentation. The raw summary confirms the change is a docs-only addition of that example to http_hooks.md, so the …
Description check Passed The description states that the change adds a Spooky Particles example to the HTTP hooks page, after the Watchgoose example. It also covers the ping URL behaviour, the hook settings used, and the test…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the main change: a Spooky Particles example added to the HTTP hooks documentation. The raw summary confirms the change is a docs-only addition of that example to http_hooks.md, so the title matches the changeset.

Full details: Description check

Explanation

The description states that the change adds a Spooky Particles example to the HTTP hooks page, after the Watchgoose example. It also covers the ping URL behaviour, the hook settings used, and the testing performed. This relates directly to the changeset.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7ca9e269-bbf9-43eb-8fbb-ca173232ea07
Commits

Reviewing files that changed from the base of the PR and between daeff82 and b6ea4c9.

Files selected for processing: 1

  • docs/content/configuration/http_hooks.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant