Add event platform to ntfy integration #38726
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes update the ntfy integration documentation and metadata. The integration's manifest now includes "event" in both the category and platforms lists. The documentation is expanded with a new section describing how event entities are created for each configured topic, subscribing to real-time notifications and exposing notification content and metadata as attributes. The documentation also details how these event entities can be used in automations within Home Assistant. Changes
Sequence Diagram(s)sequenceDiagram
participant HomeAssistant
participant NtfyIntegration
participant NtfyService
HomeAssistant->>NtfyIntegration: Configure topic(s)
NtfyIntegration->>NtfyService: Subscribe to topic(s)
NtfyService-->>NtfyIntegration: Send real-time notification
NtfyIntegration->>HomeAssistant: Create/update event entity with notification content
HomeAssistant->>Automation: Use event entity to trigger actions or process notifications
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/ntfy.markdown (2)
83-83: Remove extra blank lines
Static analysis flagged multiple consecutive blank lines at line 83. Merge the two blank lines into a single blank line to comply with markdown lint rules.
Diff:@@ -82,4 +82,3 @@ {% endconfiguration_basic %} - - ## Notifiers🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
83-83: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
103-108: Include an example automation for event entities
It would be helpful to add a YAML example showing how to use these event entities in an automation trigger. For example:### Example: Automations with ntfy event entities trigger: platform: event event_type: ntfy_notification_received # replace with actual event type action: service: notify.mobile_app_your_device data: message: "Received new ntfy notification"Adding this snippet under the "Events" section can improve usability and clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/ntfy.markdown(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/ntfy.markdown
83-83: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/ntfy.markdown (2)
4-7: Verifyha_categorynaming and casing
The PR adds- Eventto theha_categorylist. Please confirm that "Event" is a supported category in Home Assistant manifests and that the casing matches the official list. If the manifest convention uses lowercase (e.g.,event), adjust accordingly.
14-17: Validate support for theeventplatform
With- eventadded toha_platforms, ensure that the core integration code actually provides aneventplatform (e.g., anevent.pyinhomeassistant/components/ntfy). Confirm that the platform is registered and documented in the core repository.
Proposed change
Adds description for event entities
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit