mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-28 05:46:48 +00:00
bebdd1c48a
We now allow passing through file_url to the Synology Chat API so the Synology Chat bot can upload files
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
---
|
|
layout: page
|
|
title: "Synology Chat"
|
|
description: "Instructions on 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 %}
|
|
name:
|
|
description: "Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
|
|
required: true
|
|
type: string
|
|
resource:
|
|
description: The incoming webhook URL.
|
|
required: true
|
|
type: string
|
|
{% endconfiguration %}
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
|
|
|
A full example of a service call:
|
|
|
|
```json
|
|
{"message": "This is a test message",
|
|
"data":{
|
|
"file_url":"https://example.com/wp-content/uploads/sites/14/2011/01/cat.jpg"
|
|
}
|
|
}
|
|
```
|