mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 23:36:50 +00:00
42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "REST"
|
|
description: "Instructions on how to add RESTful notifications to Home Assistant."
|
|
date: 2016-02-12 07:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: restful.png
|
|
ha_category: Notifications
|
|
ha_release: 0.13
|
|
---
|
|
|
|
|
|
The `rest` notification platform allows you to deliver [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) notifications from Home Assistant to another party.
|
|
|
|
To enable the REST notification in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: rest
|
|
resource: http://IP_ADDRESS/ENDPOINT
|
|
```
|
|
|
|
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`.
|
|
- **resource** (*Required*): The resource or endpoint that will receive the value.
|
|
- **method** (*Optional*): The method of the request. Default is `GET`. Other valid options are `POST` or `POST_JSON`.
|
|
- **headers** (*Optional*): The headers for the request.
|
|
- **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`.
|
|
- **title_param_name** (*Optional*): Parameter name for the title. Defaults to none.
|
|
- **target_param_name** (*Optional*): Parameter name for the target. Defaults to none.
|
|
- **data** (*Optional*): Dictionary of extra parameters to send to the resource.
|
|
- **data_template** (*Optional*): Template dictionary of extra parameters to send to the resource.
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
|
|