From 0d324e218155fcda4042aaa737bcdba4025950f6 Mon Sep 17 00:00:00 2001 From: Mike Megally Date: Thu, 1 Mar 2018 16:34:46 -0800 Subject: [PATCH] documentation for synology chat as a notification platform (#4730) * documentation for synology chat as a notification platform * Add ha_release and logo --- .../_components/notify.synology_chat.markdown | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 source/_components/notify.synology_chat.markdown diff --git a/source/_components/notify.synology_chat.markdown b/source/_components/notify.synology_chat.markdown new file mode 100644 index 00000000000..2ea2dd577d5 --- /dev/null +++ b/source/_components/notify.synology_chat.markdown @@ -0,0 +1,34 @@ +--- +layout: page +title: "Synology Chat" +description: "Instructions how to add a Synology Chat Bot notifications to Home Assistant." +date: 2018-02-15 07:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_release: 0.65 +logo: synology.png +ha_category: Notifications +--- + +The `synology_chat` notification platform allows you to deliver notifications to your [Synology Chat](https://www.synology.com/en-us/dsm/feature/chat) install as a Synology Chat bot. + +To configure a Synology Chat bot, first you must create a [Synology Chat Integration Incoming Webhook](https://www.synology.com/en-us/knowledgebase/DSM/tutorial/Collaboration/How_to_configure_webhooks_and_slash_commands_in_Chat_Integration#t2.1). After this is complete, you will have a Webhook URL. This is what will be required in the Home Assistant configuration. + +To enable the Synology Chat notification in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + - platform: synology_chat + name: hass_synchat + resource: https://example.your.synology.com/webapi/entry.cgi?api=SYNO.Chat.External&method=incoming&version=1&token=ABCDEFG +``` + +Configuration variables: + +- **name** (*Required*): Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- **resource** (*Required*): The incoming webhook URL. + +To use notifications, please see the [getting started with automation page](/getting-started/automation/).