Connectors / Service / OpsGenie

Artisan IMG > OpsGenie (opsgenie)

OpsGenie

Opsgenie is a modern development and IP operations incident management platform, that helps you manage situations and plan for potential disruptions using always-on services.

Overview

Using dynamic reporting and analytics, Opsgenie receives alerts from your monitoring systems and custom applications, and categorizes each alert based on importance and timing. The OpsGenie connector allows you to connect with Atlassian's powerful DevOps tool,making it easier to be notified of incidents on your services, respond to them, and plan for them.

Authentication

In order to authenticate with Tray.io, you will need an API key. To get this, first log into your OpsGenie account.

opsgenie-account-page

Go to 'Settings' (this is the gear icon on the left hand side, when you hover over it the menu options will slide out):

opsgenie-settings

Once you are in your 'Settings', scroll down on the settings menu options until you come to 'API Key management':

opsgenie-api-key

Here you will have a list of current keys (if any) and the option to create new ones. Click on the 'Add new API key' button.

opsgenie-api-new-key

You will get a pop up with your new API key and usability options displayed. Copy your key and keep it safe for later use, while making sure you align your permissions as needed.

opsgenie-new-key

Go to your Tray.io dashboard and in the relevant project, once you have your Opsgenie connector is in place, create a new authentication. Make sure said connector is highlighted, thereby giving you the option of clicking on the 'New Authentication' in the properties panel on the right hand side:

opsgenie-auth

In the pop-up box that appears, enter your Authorization key (this is technically the API key you gathered from the Opsgenie site from earlier).

opsgenie-new-auth-window

Assuming the Authorization key was correct, you will now be able to use the OpsGenie connector.

Note on Operations usage

As you can see from the operations list below, the OpsGenie connector is primarily for alert management.

Note that there are also operations for updating various properties of an alert: description,message, priority, tags, team assignment, and responder.

The 'Get request status' operation can also be used to retrieve the status of a request using its ID.

All Operations

Latest version:

1.0

List alerts

Get a list of alerts

List schedules DDL

Delete alert tags

Delete tags that have been given to an alert.

Acknowledge alert

Set the alert status to acknowledged.

Assign alert

Assign an alert to a user

Close alert

Set the alert status to closed.

Create alert

Create an alert

Create note for alert

Create a note for an alert.

Delete alert

Delete an alert

Escalate alert to next

The next available escalation rule after the last processed escalation rule will be processed.

Get alert

Get an alert using its ID.

Get request status

Get the status of a request using its ID.

List escalations DDL

List tags by alert DDL

List teams DDL

List users DDL

Snooze alert

Snooze an alert for a given period ( > 7 days).

Unacknowledge alert

Set the alert status to unacknowledged.

Update alert description

Update the description for an alert.

Update alert message

Update the message for an alert.

Update alert priority

Update the priority for an alert.

Update alert tags

Update the tags for an alert.

Update alert team assignment

Update the team assignment for an alert.

Update responder to alert

Update responders for an alert.