Modify switchbot_cloud doc and addd note for webhook support #36285
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the SwitchBot Cloud integration has been updated to include a new section detailing webhook support. This addition clarifies that vacuum states are updated via SwitchBot's cloud and warns that only one webhook URL can be used. Users needing notifications for multiple applications are advised to implement a proxy for message redistribution. The overall structure and content of the documentation remain unchanged, with no modifications to existing sections or functionalities. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant SwitchBot Cloud
participant Application
User->>SwitchBot Cloud: Sends webhook request
SwitchBot Cloud-->>User: Acknowledges request
SwitchBot Cloud->>Application: Sends state update
Application-->>SwitchBot Cloud: Acknowledges update
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
source/_integrations/switchbot_cloud.markdown (4)
68-69: Fix grammatical error and improve clarityThe current text has a grammatical error and could be clearer.
-For vacuums, theirs states are updated from SwitchBot's cloud. +Vacuum states are automatically updated through SwitchBot's cloud service.
70-72: Improve warning message clarity and formalityThe warning message should use more formal language and provide clearer guidance.
{% warning %} -Only ONE webhook URL seems to be accepted by the SwitchBot's cloud. So, if you want several applications to be notified, it's not possible, or you'll have to go through a "proxy" which will re-dispatch the message to the other applications. +SwitchBot's cloud service supports only one webhook URL per account. If you need to notify multiple applications, you must implement a proxy server that receives the webhook notifications and redistributes them to your other applications. {% endwarning %}🧰 Tools
🪛 Markdownlint (0.35.0)
72-72: null
Files should end with a single newline character(MD047, single-trailing-newline)
72-72: Add missing newline at end of fileAdd a newline character at the end of the file to comply with markdown formatting standards.
🧰 Tools
🪛 Markdownlint (0.35.0)
72-72: null
Files should end with a single newline character(MD047, single-trailing-newline)
66-67: Consider adding reference to related core PRSince this webhook feature is related to core PR #132882, consider adding a note referencing this for better context and traceability.
## Webhook support +This feature was introduced in [PR #132882](https://github.com/home-assistant/core/pull/132882). +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/switchbot_cloud.markdown(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
source/_integrations/switchbot_cloud.markdown
72-72: null
Files should end with a single newline character
(MD047, single-trailing-newline)
Proposed change
Added doc for webhook support in switchbot cloud integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit