REST

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

Configuration Variables

name

(string)(Optional)

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

Default value:

notify

resource

(string)(Required)

The resource or endpoint that will receive the value.

method

(string)(Optional)

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

Default value:

GET

verify_ssl

(boolean)(Optional)

Verify the SSL certificate of the endpoint.

Default value:

true

authentication

(string)(Optional)

Type of the HTTP authentication. basic or digest.

Default value:

basic

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)

Parameter name for the message.

Default value:

message

title_param_name

(string)(Optional)

Parameter name for the title.

target_param_name

(string)(Optional)

Parameter name for the target.

data

(string)(Optional)

Dictionary of extra parameters to send to the resource.

data_template

(template)(Optional)

Template dictionary of extra parameters to send to the resource.