2024.12.2
Home ▸ Integrations ▸

RESTful Notifications

The rest notification platform allows you to deliver RESTful notifications from Home Assistant to another party.

To enable the REST notification in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: rest
    resource: http://IP_ADDRESS/ENDPOINT

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME action.

resource string Required

The resource or endpoint that will receive the value.

method string (Optional, default: GET)

The method of the request. Valid options are GET, POST or POST_JSON.

verify_ssl boolean (Optional, default: true)

Verify the SSL certificate of the endpoint.

authentication string (Optional, default: basic)

Type of the HTTP authentication. basic or digest.

username string (Optional)

The username for accessing the REST endpoint.

password string (Optional)

The password for accessing the REST endpoint.

headers string (Optional)

The headers for the request.

message_param_name string (Optional, default: message)

Parameter name for the message.

title_param_name string (Optional)

Parameter name for the title.

target_param_name string (Optional)

Parameter name for the target.

data template (Optional)

Template dictionary of extra parameters to send to the resource.

To use notifications, please see the getting started with automation page.

Using templates

For incoming data, a value template translates incoming JSON or raw data to a valid payload. Incoming payloads are rendered with possible JSON values, so when rendering, the value_json can be used to access the attributes in a JSON based payload, otherwise the value variable can be used for non-json based data.

Additional, the this can be used as variables in the template. The this attribute refers to the current entity state of the entity. Further information about this variable can be found in the template documentation

Note

Example value template with json:

With given payload:

{ "state": "ON", "temperature": 21.902 }

Template {{ value_json.temperature | round(1) }} renders to 21.9.