jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 09:46:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add examples of how to use new Mastodon service functionality (#28140)

Browse Source 
* Added examples of how to use new Mastodon srevice functionality

* Tiny tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Jeffrey Stone 2024-05-17 00:17:48 -04:00 committed by GitHub
parent 02334c0ef4
commit a585f31359
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 65 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
source/_integrations/mastodon.markdown
View File

@ -63,4 +63,68 @@ base_url:
default: https://mastodon.social
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
### Usage
Mastodon is a notify platform, and can be used by calling notify service as described in the [notify documentation](/integrations/notify/). It will toot messages using
your account. An optional **target** parameter can be given to specify whether your toot will be public, private, unlisted, or direct.
| Service attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `message` | no | Body of the notification.
| `target` | yes | If not used, will default to account setting. `public`: post will be public, `unlisted`: post will be public but not appear on the public timeline, `private`: post will only be visible to followers, and `direct`: post will only be visible to mentioned users.
| `data` | yes | See below for extended functionality.
### Service data
The following attributes can be placed inside `data` for extended functionality.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `media` | yes | Attach an image or video to the message.
| `media_warning` | yes | If an image or video is attached, `True`: will marked the media as sensitive. `False` is default.
| `content_warning` | yes | Text will be be shown as a warning before the text of the status. If not used, no warning will be displayed.
### Example service call
This will post a message to Mastodon. Visibility will default to your account's setting.
```yaml
- service: notify.mastodon
message: "A toot from Home Assistant"
```
### Example service call - private
This will post a message to Mastodon, but visibility is marked as `private` so only followers will see it.
```yaml
- service: notify.mastodon
message: "A private toot from Home Assistant"
target: private
```
### Example service call - with media
This will post a message to Mastodon that includes an image.
```yaml
- service: notify.mastodon
message: "A media toot from Home Assistant"
data:
media: /config/www/funny_meme.png
```
### Example service call - with media and content warning to hide post behind a warning
This will post a message to Mastodon that includes an image and a target of `unlisted`, so it doesn't show in the public timeline.
```yaml
- service: notify.mastodon
message: "A media toot from Home Assistant"
target: unlisted
data:
media: /config/www/funny_meme.png
content_warning: "This might not be funny enough"
```
For more on how to use notifications in your automations, please see the [getting started with automation page](/getting-started/automation/).