HipChat

HipChat is hosted group chat and video chat for companies and teams.

kawasemi uses one of the Room API for sending notification to HipChat.

Settings

You can obtain a Room API ID and a Room Notification Token from HipChat Rooms Page.

config = {
    "CHANNELS": {
        "hipchat": {
            "_backend": "kawasemi.backends.hipchat.HipChatChannel",
            # Required
            # Room API ID
            "api_id": "1234567",
            # Room Notification Token
            "token": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
            # Optional
            # Only for HipChat Server
            "base_url": "https://api.hipchat.com/v2/",
            # Background color for message
            # Valid values: yellow, green, red, purple, gray, random
            "color": "random",
            # Whether this message should trigger a user notification
            "notify": True,
            # Determines how the message is treated by HipChat server and rendered inside HipChat applications
            # Valid values: html, text
            "message_format": "html"
        }
    }
}

Options

You can specify all options available in the Room API. For instance:

kawasemi.send("Sample notification.", options={
    "hipchat": {
        "color": "green",
        "notify": False,
        "message_format": "text"
    }
})