diff --git a/source/_components/notify.twitter.markdown b/source/_components/notify.twitter.markdown new file mode 100644 index 00000000000..97ea742ce19 --- /dev/null +++ b/source/_components/notify.twitter.markdown @@ -0,0 +1,38 @@ +--- +layout: component +title: "Twitter" +description: "Instructions how to add Twitter notifications to Home Assistant." +date: 2016-01-27 07:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: twitter.png +ha_category: Notifications +--- + + +The `twitter` platform uses [Twitter](https://twitter.com) to delivery notifications from Home Assistant. + +Go to [Twitter Apps](https://apps.twitter.com/app/new) and create an application. Visit "Keys and Access Tokens" of the application to get the details ("Consumer Key", "Consumer Secret", and "Access Token Secret" which needs to be generated). + +To add Twitter to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + name: NOTIFIER_NAME + platform: twitter + consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ + consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ + access_token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ +``` + +Configuration variables: + +- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- **consumer_key** (*Required*): Your "Consumer Key" (API Key) for the application. +- **consumer_secret** (*Required*): Your "Consumer Secret" (API Secret) for the application. +- **access_token_secret** (*Required*): Your "Access Token Secret" for the application. + +To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation/). diff --git a/source/images/supported_brands/twitter.png b/source/images/supported_brands/twitter.png new file mode 100644 index 00000000000..c9b89357977 Binary files /dev/null and b/source/images/supported_brands/twitter.png differ