HipChat


This component will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: announcement.

Hipchat will be discontinued after February 15th, 2019. This to give customers the opportunity to make a switch.

The hipchat platform allows you to send notifications from Home Assistant to HipChat.

You need to obtain a HipChat API token to be able to send notifications.

To enable the HipChat notification in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: hipchat
    token: YOUR_TOKEN
    room: 1234567

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

token

(string)(Required)The HipChat API token to use for sending HipChat notifications.

room

(integer)(Required)The default room to post to if no room is explicitly specified when sending the notification.

color

(string)(Optional)Setting color will override the default color for the notification. Valid options are ‘yellow’, ‘green’, ‘red’, ‘purple’, ‘gray’, ‘random’.

Default value: yellow

notify

(boolean)(Optional)Setting notify will override the default notify (blink application icon, chime, or otherwise call attention) setting for the notification. Valid options are ‘true’ and ‘false’.

Default value: false

format

(string)(Optional)Setting format will override the default message format. Valid options are ‘text’ and ‘html’.

Default value: text

host

(string)(Optional)Setting the host will override the default HipChat server host.

Default value: https://api.hipchat.com/

HipChat service data

The following attributes can be placed data for extended functionality.

Service data attribute Optional Description
room yes (int) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
color yes (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
notify yes (bool) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
format yes (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.

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