2024.11.3
Home ▸ Integrations ▸

Mastodon

The mastodon platform uses Mastodon to deliver notifications from Home Assistant.

Setup

Go to Preferences in the Mastodon web interface, then to Development and create a new application. If you want to grant only required accesses, uncheck all checkboxes then check only read:accounts and write:statuses.

Configuration

To add the Mastodon service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Mastodon.

  • Follow the instructions on screen to complete the setup.

URL

The URL of your Mastodon instance, for example https://mastodon.social.

Client key

The client key for the application created within your Mastodon account web interface.

Client secret

The client secret for the application created within your Mastodon account web interface.

Access token

The access token for the application created within your Mastodon account web interface.

Sensors

The integration will create sensors for the Mastodon account showing total followers, following, and posts. Sensors are updated once an hour.

Notifications

The integration will create a notify action matching the name of the integration entry.

Action usage

Mastodon is a notify platform, and can be used by calling notify action as described in the notify documentation. 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.

Data 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.

Action data

The following attributes can be placed inside data for extended functionality.

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 action

This will post a message to Mastodon. Visibility will default to your account’s setting.

- action: notify.mastodon
  message: "A toot from Home Assistant"

Example action - private

This will post a message to Mastodon, but visibility is marked as private so only followers will see it.

- action: notify.mastodon
  message: "A private toot from Home Assistant"
  target: private

Example action - with media

This will post a message to Mastodon that includes an image.

- action: notify.mastodon
  message: "A media toot from Home Assistant"
  data:
    media: /config/www/funny_meme.png

Example action - 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.

- action: 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.

Known limitations

The integration only allows reading the status of the authenticated account and posting to that account. It does not provide functionality to get the stream, favorite, bookmark, or boost posts of that account.

Removing the integration

This integration follows standard integration removal, once the integration is removed you can remove the application registration (assuming it was only used by this integration) from your Mastodon account by going to Preferences in the Mastodon web interface, then to Development and deleting the application you created for Home Assistant.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.