mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-06 02:06:48 +00:00
57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
---
|
|
layout: page
|
|
title: "Flock"
|
|
description: "Instructions on how to add Flock notifications to Home Assistant."
|
|
date: 2017-08-17 18:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: flock.png
|
|
ha_category: Notifications
|
|
ha_release: 0.71
|
|
---
|
|
|
|
|
|
The `flock` platform uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant.
|
|
|
|
## {% linkable_title Setup %}
|
|
|
|
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*.
|
|
|
|
<p class='img'>
|
|
<img src='{{site_root}}/images/components/flock/flock-webhook.png' />
|
|
</p>
|
|
|
|
You will need the last part of the URL which is the `access_token` for your room.
|
|
|
|
<p class='img'>
|
|
<img src='{{site_root}}/images/components/flock/new-webhook.png' />
|
|
</p>
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
To add Flock notifications to your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: flock
|
|
access_token: YOUR_ROOM_TOKEN
|
|
```
|
|
|
|
{% configuration %}
|
|
name:
|
|
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
|
|
required: false
|
|
type: string
|
|
default: notify
|
|
access_token:
|
|
description: The last part of the webhook URL.
|
|
required: true
|
|
type: string
|
|
{% endconfiguration %}
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|