Skip to content

feat(docs): add gotify example using webhook custom payload - #5408

Open
TheMeier wants to merge 1 commit into
prometheus:mainfrom
TheMeier:gotify_example
Open

feat(docs): add gotify example using webhook custom payload#5408
TheMeier wants to merge 1 commit into
prometheus:mainfrom
TheMeier:gotify_example

Conversation

@TheMeier

Copy link
Copy Markdown
Contributor

Pull Request Checklist

Please check all the applicable boxes.

Which user-facing changes does this PR introduce?

NONE

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c047d9a5-c6b6-481e-91e7-49a1d6800545

📥 Commits

Reviewing files that changed from the base of the PR and between d036b5e and dd7ca93.

📒 Files selected for processing (3)
  • docs/configuration.md
  • docs/notification_examples.md
  • examples/webhook/gotify.yml
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/configuration.md
  • examples/webhook/gotify.yml
  • docs/notification_examples.md

📝 Walkthrough

Walkthrough

Adds a Gotify webhook configuration example with secret-based authentication, templated payload fields, alert rendering, and links from the Alertmanager documentation.

Changes

Gotify webhook documentation

Layer / File(s) Summary
Gotify webhook configuration
examples/webhook/gotify.yml
Defines a Gotify receiver with X-Gotify-Key authentication, resolved notifications, Markdown formatting, conditional priority, and templated alert messages.
Gotify usage documentation
docs/notification_examples.md, docs/configuration.md
Documents the generic webhook setup for Gotify and links to additional payload examples.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR documents a generic webhook workaround but does not add Gotify as a dedicated Alertmanager receiver requested by issue #2120. Confirm that the generic webhook example satisfies issue #2120, or implement and test a dedicated Gotify receiver.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the added Gotify webhook custom-payload example.
Description check ✅ Passed The description identifies issue #2120, documents the completed work, marks relevant checklist items, and specifies that no release note is needed.
Out of Scope Changes check ✅ Passed All changes concern the Gotify webhook integration and its documentation, so no unrelated out-of-scope changes are evident.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@examples/webhook/gotify.yml`:
- Line 38: Update the Gotify priority template in the webhook example to remove
the surrounding quotes, so firing and non-firing statuses render integer values
5 and 0 rather than strings. Apply the same change to the mirrored Gotify
example in docs/notification_examples.md.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0b9f60ec-8dc5-4172-ae4b-31a2aa3e02c9

📥 Commits

Reviewing files that changed from the base of the PR and between 846bdbf and d036b5e.

📒 Files selected for processing (3)
  • docs/configuration.md
  • docs/notification_examples.md
  • examples/webhook/gotify.yml

Comment thread examples/webhook/gotify.yml
Signed-off-by: Christoph Maser <christoph.maser+github@gmail.com>
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.

Feature suggestion: Add Gotify as receiver

1 participant