HipChat

ENTERPRISE: Built-in integrations are available for Sensu Enterprise users only.

Overview

Send notifications to a HipChat room for events. After creating a HipChat API token, configure the handler (integration) with the provided API token.

Configuration

Example(s)

The following is an example global configuration for the hipchat enterprise event handler (integration).

{
  "hipchat": {
    "api_token": "L7kVQzXF7c5eUMYUon6INaSVRDU8mP",
    "api_version": "v2",
    "username": "sensu",
    "room": "Operations",
    "timeout": 10
  }
}

Integration Specification

hipchat attributes

The following attributes are configured within the {"hipchat": {} } configuration scope.

api_token
description The HipChat API token - https://www.hipchat.com/docs/api/auth.
required true
type String
example
"api_token": "L7kVQzXF7c5eUMYUon6INaSVRDU8mP"
server_url
description The URL of the HipChat server (used for self-hosted HipChat installations)
required false
type String
example
"server_url": "https://hipchat.example.com"
api_version
description The HipChat API version to use.
required false
type String
default v2
example
"api_version": "v2"
username
description The HipChat username to use to notify the room.
required false
type String
default sensu
example
"username": "monitoring"
room
description The HipChat room to notify.
required false
type String
default sensu
example
"room": "Search"
notify
description Configures whether notifications sent from Sensu Enterprise to HipChat should trigger a user notification (change the tab color, play a sound, notify mobile phones, etc). Each recipient’s notification preferences are taken into account.
required false
type Boolean
default false
example
"notify": true
filters
description An array of Sensu event filters (names) to use when filtering events for the handler. Each array item must be a string. Specified filters are merged with default values.
required false
type Array
default
["handle_when", "check_dependencies"]
example
"filters": ["recurrence", "production"]
severities
description An array of check result severities the handler will handle. NOTE: event resolution bypasses this filtering.
required false
type Array
allowed values ok, warning, critical, unknown
example
 "severities": ["critical", "unknown"]
timeout
description The handler execution duration timeout in seconds (hard stop).
required false
type Integer
default 10
example
"timeout": 30