Home Assistant Home Assistant

Twitter

The twitter notification platform uses Twitter to deliver notifications from Home Assistant.

Setup

Make sure you have a developer account registered with Twitter, then go to Twitter Apps and create an application. If you don’t have a developer account you need to apply for one, it can take some time to get approved. Visit “Keys and Access Tokens” of the application to get the details (Consumer Key, Consumer Secret, Access Token and Access Token Secret which needs to be generated).

Configuration

To add Twitter to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: twitter
    consumer_key: YOUR_API_KEY
    consumer_secret: YOUR_API_SECRET
    access_token: YOUR_ACCESS_TOKEN
    access_token_secret: YOUR_ACCESS_SECRET

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.

consumer_key string Required

Your Consumer Key (API Key) for the application.

consumer_secret string Required

Your Consumer Secret (API Secret) for the application.

access_token string Required

Your Access Token for the application.

access_token_secret string Required

Your Access Token Secret for the application.

username string (Optional)

Twitter handle without @ or with @ and quoting for direct messaging.

To use notifications, please see the getting started with automation page.