Add message_thread_id to telegram_text and telegram_command events

[DrDonoso]

Proposed change

Add message_thread_id to telegram_text and telegram_command events

Type of change

• Spelling, grammar or other readability improvements (current branch).
• Adjusted missing or incorrect information in the current documentation (current branch).
• Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • I've opened up a PR to add logos and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: Add message_thread_id to telegram_text and telegram_command events core#130738
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• New Features

  • Introduced message_thread_id attribute for managing threaded conversations in Telegram bot actions.
  • Streamlined configuration process for the Telegram notification platform, reducing required fields.

• Documentation

  • Updated documentation to clarify YAML configuration and usage of the new message_thread_id attribute.
  • Enhanced examples to illustrate practical applications of the new features.

[home-assistant]

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	980530b
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67385dc0212bdd0008d1713f
😎 Deploy Preview	https://deploy-preview-35785--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes made to the Telegram bot integration documentation in Home Assistant include the introduction of the message_thread_id attribute across various action definitions. This attribute enables messages to be directed to specific threads within a chat. The documentation has also been updated to clarify the YAML configuration for the telegram notification platform, ensuring backward compatibility while simplifying the configuration process. Additionally, examples have been revised to demonstrate the use of the new attribute in practical scenarios.

Changes

File	Change Summary
source/_integrations/telegram_bot.markdown	Added message_thread_id attribute to action definitions for various message types, updated YAML configuration details, and revised examples to reflect these changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TelegramBot
    participant HomeAssistant

    User->>HomeAssistant: Send message
    HomeAssistant->>TelegramBot: Send message with message_thread_id
    TelegramBot->>User: Message sent to specific thread

Loading

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

source/_integrations/telegram_bot.markdown (1)

Line range hint 1-1000: Consider adding a usage example for message_thread_id.

To help users understand how to use the new message_thread_id attribute, consider adding a practical example in the Configuration samples section. This could demonstrate sending a message to a specific thread.

Here's a suggested example to add:

# Example: send message to a specific thread
actions:
  - action: notify.telegram
    data:
      message: "This message will appear in a specific thread"
      data:
        message_thread_id: 123456

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between db9e0a0 and 980530b.

📒 Files selected for processing (1)

• source/_integrations/telegram_bot.markdown (2 hunks)

🔇 Additional comments (2)

source/_integrations/telegram_bot.markdown (2)

316-317: LGTM: Event data documentation is clear and consistent.

The addition of the message_thread_id attribute to both telegram_command and telegram_text event data sections is well-documented and follows the existing format.

Also applies to: 329-330

---

Line range hint 1-1000: LGTM: Action definitions are thoroughly documented.

The message_thread_id attribute has been consistently added to all relevant action definitions with clear descriptions and proper optional status marking.