HipChat Integration Guide

  • 2 minute(s) read
Prev Next

HipChat is a group chat, file sharing, video chat, and screen-sharing application built for teams & business. Collaborate from anywhere with apps on desktop & mobile. HipChat features:

  • Group video chat and screen sharing: Easily start a group video chat from any room, and share your desktop screen with teammates.
  • Drag-and-drop file sharing: Grab and share files from your desktop, Dropbox, email, or anywhere.
  • Unlimited chat rooms: Create rooms for projects, teams, or clients. When you're finished with a chat room just archive it.
  • Persistent messaging: HipChat synchronizes across desktop, mobile, and web apps.
  • Searchable chat history: Every room is searchable by keyword, including text, links, files, and more.

For more information, go to https://www.hipchat.com Download the latest software at https://www.hipchat.com/downloads

Catchpoint Integration

Catchpoint’s Alert Webhook allows Catchpoint to integrate with other tools by pushing data when a test triggers an alert. Any tool supporting Webhooks or providing a URL to POST data can be used. Alert Webhook templates can be customized to fit a tool’s format and content-type using Macros. If a template needs modification, please contact Catchpoint Support. We are happy to assist you in creating a template meeting your requirements. Below, you will find steps for setting up and customizing templates. This guide is a standard workflow created by Catchpoint focused on creating and confirming an API template to be consumed by this tool. Catchpoint does its best to ensure the relevance of these guides and will be happy to assist in implementing a guide as described.

HipChat Setup

In HipChat, select Integrations in the Room actions menu. Select Build your own. Give it a name and select Create. You will now have an endpoint URL and an example curl command for getting data into HipChat.

Catchpoint Setup

Webhook:

The Alert Webhook can be used either with the default JSON that Catchpoint sends when alerting, or you can define a custom template to choose what data gets sent via the Webhook.

  1. Click on the API link in the Settings module.
  2. Set the status to active and EndPoint URL to the endpoint URL associated with your HipChat account.
  3. If you wish to use a custom template, in the Alerts Webhook section select the radio button labeled Template.
  4. Click Add new in the template selection drop-down menu. (Existing templates can be edited in the menu by hovering over the template name and selecting the Edit/View Properties icon.
  5. A lightbox will pop up where you can create a name for the template and define the contents. The content should be valid JSON.
    alert_webhook.PNG

Alert Macro Usage:

The JSON or XML fields can be hardcoded as well as filled in dynamically with data provided from the system. This includes data like the test name, the alert severity, conditions that triggered the alert, location of the node for which a test run caused an alert to trigger, etc.

An example uses for the Alert Webhook Template to provide the timestamp and severity level for an alert in JSON where macros are used with the following syntax, ${macroName}.

The initialTriggerTimestamp macro can be used to link reminder and improved alerts to the original trigger alert. This can be used to link related alerts and prevent duplication for related alerts.

Example:

{
    "incident_key": "${initialTriggerTimestamp}",
    "event_type": "trigger",
    "description": "${switch("${notificationLevelId}","0","WARNING","1","CRITICAL","3","OK")}",
    "client": "${productId}",
    "client_url": "${testUrl}",
    "details": {
        "node": "${nodeDetails("${nodeName}")}"
        }
    "notify":true,
    "message_format":"text"
}

Alert Macro Index

A full list of the Alert Webhook Macros can be found here:https://docs.catchpoint.com/docs/Alert-Webhook-Macro-Index