2024.11.3
Home ▸ Integrations ▸

X

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

Setup

Make sure you have a developer account registered with X, then go to X 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.

App permissions

If you do not perform this step, your application will only receive read permissions and will not be able to post tweets on behalf of your account on X.

  1. Visit Settings of the application.
  2. Select Set up under User authentication settings.
  3. Check the box for OAuth 1.0a.
  4. Set the app permission to Read and write.
  5. Enter a callback and website URL and click save.

It does not matter for the integration what you enter as a callback or website URL.

Generate tokens and secrets

  1. Visit Keys and tokens of the application.
  2. Select Regenerate under Consumer keys to get your Consumer Key and Consumer Secret.
  3. Select Regenerate under Access Tokens and Secret to get your Access Token and Access Token Secret.

Configuration

To add X to your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] 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 notify.NOTIFIER_NAME action.

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)

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

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