Add parse_mode to service call API
All checks were successful
Validate / Hassfest (push) Successful in 3s
All checks were successful
Validate / Hassfest (push) Successful in 3s
This commit is contained in:
81
README.md
81
README.md
@@ -171,14 +171,30 @@ data:
|
||||
reply_to_message_id: 123
|
||||
```
|
||||
|
||||
HTML formatting:
|
||||
|
||||
```yaml
|
||||
service: immich_album_watcher.send_telegram_notification
|
||||
target:
|
||||
entity_id: sensor.album_name_asset_count
|
||||
data:
|
||||
chat_id: "-1001234567890"
|
||||
caption: |
|
||||
<b>Album Updated!</b>
|
||||
New photos by <i>{{ trigger.event.data.added_assets[0].asset_owner }}</i>
|
||||
<a href="https://immich.example.com/album">View Album</a>
|
||||
parse_mode: "HTML" # Default, can be omitted
|
||||
```
|
||||
|
||||
| Field | Description | Required |
|
||||
|-------|-------------|----------|
|
||||
| `chat_id` | Telegram chat ID to send to | Yes |
|
||||
| `urls` | List of media items with `url` and `type` (photo/video). Empty for text message. | No |
|
||||
| `bot_token` | Telegram bot token (uses configured token if not provided) | No |
|
||||
| `caption` | For media: caption applied to first item. For text: the message text. | No |
|
||||
| `caption` | For media: caption applied to first item. For text: the message text. Supports HTML formatting by default. | No |
|
||||
| `reply_to_message_id` | Message ID to reply to | No |
|
||||
| `disable_web_page_preview` | Disable link previews in text messages | No |
|
||||
| `parse_mode` | How to parse caption/text. Options: `HTML`, `Markdown`, `MarkdownV2`, or empty string for plain text. Default: `HTML` | No |
|
||||
| `max_group_size` | Maximum media items per group (2-10). Large lists split into multiple groups. Default: 10 | No |
|
||||
| `chunk_delay` | Delay in milliseconds between sending multiple groups (0-60000). Useful for rate limiting. Default: 0 | No |
|
||||
|
||||
@@ -186,7 +202,20 @@ The service returns a response with `success` status and `message_id` (single me
|
||||
|
||||
## Events
|
||||
|
||||
Use these events in your automations:
|
||||
The integration fires multiple event types that you can use in your automations:
|
||||
|
||||
### Available Events
|
||||
|
||||
| Event Type | Description | When Fired |
|
||||
|------------|-------------|------------|
|
||||
| `immich_album_watcher_album_changed` | General album change event | Fired for any album change |
|
||||
| `immich_album_watcher_assets_added` | Assets were added to the album | When new photos/videos are added |
|
||||
| `immich_album_watcher_assets_removed` | Assets were removed from the album | When photos/videos are removed |
|
||||
| `immich_album_watcher_album_renamed` | Album name was changed | When the album is renamed |
|
||||
| `immich_album_watcher_album_deleted` | Album was deleted | When the album is deleted from Immich |
|
||||
| `immich_album_watcher_album_sharing_changed` | Album sharing status changed | When album is shared or unshared |
|
||||
|
||||
### Example Usage
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
@@ -199,21 +228,47 @@ automation:
|
||||
data:
|
||||
title: "New Photos"
|
||||
message: "{{ trigger.event.data.added_count }} new photos in {{ trigger.event.data.album_name }}"
|
||||
|
||||
- alias: "Album renamed"
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: immich_album_watcher_album_renamed
|
||||
action:
|
||||
- service: notify.mobile_app
|
||||
data:
|
||||
title: "Album Renamed"
|
||||
message: "Album '{{ trigger.event.data.old_name }}' renamed to '{{ trigger.event.data.new_name }}'"
|
||||
|
||||
- alias: "Album deleted"
|
||||
trigger:
|
||||
- platform: event
|
||||
event_type: immich_album_watcher_album_deleted
|
||||
action:
|
||||
- service: notify.mobile_app
|
||||
data:
|
||||
title: "Album Deleted"
|
||||
message: "Album '{{ trigger.event.data.album_name }}' was deleted"
|
||||
```
|
||||
|
||||
### Event Data
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `album_id` | Album ID |
|
||||
| `album_name` | Album name |
|
||||
| `album_url` | Public URL to view the album (only present if album has a shared link) |
|
||||
| `change_type` | Type of change (assets_added, assets_removed, changed) |
|
||||
| `added_count` | Number of assets added |
|
||||
| `removed_count` | Number of assets removed |
|
||||
| `added_assets` | List of added assets with details (see below) |
|
||||
| `removed_assets` | List of removed asset IDs |
|
||||
| `people` | List of all people detected in the album |
|
||||
| Field | Description | Available In |
|
||||
|-------|-------------|--------------|
|
||||
| `hub_name` | Hub name configured in integration | All events |
|
||||
| `album_id` | Album ID | All events |
|
||||
| `album_name` | Current album name | All events |
|
||||
| `album_url` | Public URL to view the album (only present if album has a shared link) | All events except `album_deleted` |
|
||||
| `change_type` | Type of change (assets_added, assets_removed, album_renamed, album_sharing_changed, changed) | All events except `album_deleted` |
|
||||
| `shared` | Current sharing status of the album | All events except `album_deleted` |
|
||||
| `added_count` | Number of assets added | `album_changed`, `assets_added` |
|
||||
| `removed_count` | Number of assets removed | `album_changed`, `assets_removed` |
|
||||
| `added_assets` | List of added assets with details (see below) | `album_changed`, `assets_added` |
|
||||
| `removed_assets` | List of removed asset IDs | `album_changed`, `assets_removed` |
|
||||
| `people` | List of all people detected in the album | All events except `album_deleted` |
|
||||
| `old_name` | Previous album name | `album_renamed` |
|
||||
| `new_name` | New album name | `album_renamed` |
|
||||
| `old_shared` | Previous sharing status | `album_sharing_changed` |
|
||||
| `new_shared` | New sharing status | `album_sharing_changed` |
|
||||
|
||||
### Added Assets Fields
|
||||
|
||||
|
||||
Reference in New Issue
Block a user