Skip to content

Commit dcc9b41

Browse files
authored
Add Flock notify documentation (home-assistant#5395)
* Add Flock notify documentation * Update 'ha_release'
1 parent da19c3f commit dcc9b41

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
layout: page
3+
title: "Flock"
4+
description: "Instructions on how to add Flock notifications to Home Assistant."
5+
date: 2017-08-17 18:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: flock.png
11+
ha_category: Notifications
12+
ha_release: 0.71
13+
---
14+
15+
16+
The `flock` platform uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant.
17+
18+
## {% linkable_title Setup %}
19+
20+
Go to the [Flock.com Admin website](https://admin.flock.com/#!/webhooks) and create a new "Incoming Webhooks". Choose a channel to send the notifications from Home Assistant to, specifiy a name and press *Save and Generate URL*.
21+
22+
<p class='img'>
23+
<img src='{{site_root}}/images/components/flock/flock-webhook.png' />
24+
</p>
25+
26+
You will need the last part of the URL which is the `access_token` for your room.
27+
28+
<p class='img'>
29+
<img src='{{site_root}}/images/components/flock/new-webhook.png' />
30+
</p>
31+
32+
## {% linkable_title Configuration %}
33+
34+
To add Flock notifications to your installation, add the following to your `configuration.yaml` file:
35+
36+
```yaml
37+
# Example configuration.yaml entry
38+
notify:
39+
- name: NOTIFIER_NAME
40+
platform: flock
41+
access_token: YOUR_ROOM_TOKEN
42+
```
43+
44+
{% configuration %}
45+
name:
46+
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
47+
required: false
48+
type: string
49+
default: notify
50+
access_token:
51+
description: The last part of the webhook URL.
52+
required: true
53+
type: string
54+
{% endconfiguration %}
55+
56+
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
79.6 KB
Loading
20.3 KB
Loading
3.2 KB
Loading

0 commit comments

Comments
 (0)