HipChat Responder setup guide - snowplow-archive/sauna GitHub Wiki

HOME > GUIDE FOR DEVOPS > SETTING UP SAUNA > RESPONDERS > HipChat Responder setup guide

This responder has not yet been released.

See also: HipChat Responder user guide

• 1. Overview
• 2. Compatibility
• 3. HipChat setup
• 4. Sauna setup
  • 4.1 Avro schema
  • 4.2 Example

This responder lets you communicate with your colleagues or partners via the HipChat messaging platform.

This responder will be released in Sauna version TBC.

• Login to HipChat as an administrator
• Click on Integrations in the secondary navigation
• From the dropdown on the left, choose the room you want to be able to send notifications to via Sauna
• Click on Build your own integration
• Add a name for your integration, e.g. Sauna and click Create
• On the next screen, look for https://snowplowanalytics.hipchat.com/v2/room/3478021/notification?auth_token=<< TOKEN >>. You will need the << TOKEN >> value below

Please note that this setup only authenticates the HipChat Responder to a single room. Commands to send notifications to another room, and non-notification-related HipChat commands, will fail.

The HipChat Responder must be configured using a self-describing Avro which validates against this JSON Schema:

iglu:com.snowplowanalytics.sauna.responders/HipchatConfig/avro/1-0-0

Where authToken is the HipChat authentication token providing access to a specific room.

We can enable this responder by placing following Avro configurations in the configuration directory (filename must have extension .avro or .json):

{
    "schema": "iglu:com.snowplowanalytics.sauna.responders/HipchatConfig/avro/1-0-0",

    "data": {
        "enabled": true,
        "id": "com.acme.MyHipchatResponder",
        "parameters": {
            "sendRoomNotificationEnabled": true,
            "authToken": "vewxR9MgcPGpbfwxceDFx9p6LbMHUkdE9ZTcPRPq"
        }
    }
}