XMPP/Jabber Integration

XMPP/Jabber is the Extensible Messaging and Presence Protocol, a set of open technologies for instant messaging, presence, multi-party chat, voice and video calls, collaboration, lightweight middleware, content syndication, and generalized routing of XML data.

What does Opsgenie offer XMPP/Jabber users?

The Opsgenie XMPP/Jabber integration plugin utilizes full capabilities of Opsgenie and provides chat integration with XMPP/Jabber. The integration leverages Opsgenie's xmpp-specific executable and OEC utility so that Opsgenie alerts and alert actions go into XMPP/Jabber rooms.

Functionality of the integration

  • When an alert is created in Opsgenie, information saying that an alert is created in Opsgenie goes into your XMPP/Jabber room.
  • When users acknowledge an alert from their mobile devices using the Opsgenie app, this info is sent to XMPP/Jabber rooms.
  • When users add comments to alerts in Opsgenie, add note info is sent as well.

OEC subscribes to alert actions in Opsgenie and reflects these actions on your XMPP/Jabber rooms so that you will be notified for Opsgenie alerts.

Installation

The steps below describe how to integrate Opsgenie and XMPP/Jabber using Opsgenie XMPP/Jabber integration plugin. Note that slight alteration to these instructions may be necessary depending on the exact Linux distribution being used and XMPP/Jabber configuration.

Prerequisites

Packages provided support the following systems:

  • Red Hat based Linux distributions
  • Debian based Linux distributions
  • Windows

Download Opsgenie XMPP/Jabber Plugin

For Red Hat Based Distributions

📘

For rhel6 distributions, you can download this package.

🚧

During upgrades, rpm package does not overwrite your existing configurations. It saves the new default configuration file as opsgenie-integration.conf.rpmnew. Find more information about rpm upgrade config file handling from here.

🚧

To update from version 201X-XX-XX to 2.X.X, add --force parameter.

For example: rpm -U --force opsgenie-integration-<your_version>.rpm

We suggest backing up configuration files before updating!

🚧

If while installing the rpm package you get an error saying that the package is obsolated, you need to use "rpm -i opsgenie-xmpp-1.0.4-rpm-x86-64.rpm --nodeps" instead.

If you get "is already installed" error, use "rpm -i opsgenie-xmpp-1.0.4-rpm-x86-64.rpm --force" instead.

For Debian Based Distributions

For Windows

  1. Download Opsgenie XMPP/Jabber (zip)
  2. Unzip opsgenie integration zip file
  3. Install OEC by following steps in OEC installation page

Add XMPP/Jabber integration in Opsgenie

📘

An alternative for this step is to add the integration from the Team Dashboard of the team which will own the integration. To add an integration directly to a team, navigate to the Team Dashboard and open Integrations tab. Click Add Integration and select the integration that you would like to add.

🚧

For Free and Essentials plans, you can only add the integrations from the Team Dashboards, please use the alternative instructions given above to add this integration.

  • Copy the API Key.
  • Click Save Integration.

Configure Opsgenie to XMPP/Jabber Integration

Use Opsgenie's OEC and the XMPP script to send alert actions to XMPP/Jabber rooms. This enables deployment of your own scripts/ability to modify the ones provided and execute customized actions on XMPP.

To use the XMPP integration package, follow the steps in the sections below through the end.

The package that you downloaded also includes OEC utility and the script that is need to be run by OEC.

To be able to execute actions in XMPP, OEC gets the configuration parameters from the configuration file. The configuration file can be found under /home/opsgenie/oec/conf/config.json

📘

In order to use this feature "Send Alert Actions To XMPP" checkbox should be enabled in Opsgenie XMPP/Jabber Integration.

Configuration Parameters

Location

apiKey

XMPP/Jabber integration API Key. Copy the API Key from XMPP/Jabber Integration page and paste it to apiKey field in conf file.

/home/opsgenie/oec/conf/config.json

hostUrl

Service name for the XMPP/Jabber server you are using. This hostUrl is used to create a connection with your XMPP/Jabber server.

/home/opsgenie/oec/conf/config.json

username

Username used during login to the XMPP/Jabber server.

/home/opsgenie/oec/conf/config.json

password

Password that used during login to the XMPP/Jabber server.

/home/opsgenie/oec/conf/config.json

room

Room name which alert actions are sent right into.

/home/opsgenie/oec/conf/config.json

Updated 4 months ago


XMPP/Jabber Integration


XMPP/Jabber is the Extensible Messaging and Presence Protocol, a set of open technologies for instant messaging, presence, multi-party chat, voice and video calls, collaboration, lightweight middleware, content syndication, and generalized routing of XML data.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.