Integrate with MongoDBCloud

Overview

What does the integration offer?

Jira Service Management has a Webhook integration with MongoDB Cloud Manager. Use the integration to send MongoDB Cloud Manager incidents to Jira Service Management API with detailed information. Jira Service Management acts as a dispatcher for MongoDB Cloud Manager alerts, determines the right people to notify based on on-call schedules – notifies via email, text messages (SMS), phone calls, and iPhone & Android push notifications, and escalates alerts until they are acknowledged or closed.

This document describes how to configure the integration and details of data that Jira Service Management receives from MongoDB Cloud Manager.

How does the integration work?

When an alert is created on MongoDB Cloud Manager, an alert is created in Jira Service Management automatically through the integration. When an alert is closed on MongoDB Cloud Manager, the related alert is closed in Jira Service Management.

Set up the integration

MongoDB Cloud Manager is an API-based integration. Setting it up involves the following steps:

Add a MongoDB Cloud Manager integration in Jira Service Management
Configure the integration in MongoDB Cloud Manager

Add MongoDB integration

If you're using the Free or Standard plan in Jira Service Management, you can only add this integration from your team’s operations page. To access the feature through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be on Premium or Enterprise plan.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management assigns the alerts received through this integration to your team only.

To add a MongoDB integration in Jira Service Management:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “MongoDB”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the API key.
You will use this URL while configuring the integration in MongoDB later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Configure the integration in MongoDB Cloud Manager

In MongoDB Cloud Manager, go to Projects > Options > Integrations.
Scroll down to Webhook Settings and select Configure.
Paste the API URL you copied while adding the integration in Jira Service Management into Webhook URL.
Select Save.

Learn more about alert configurations in MongoDB Cloud Manager.

Sample payload sent from MongoDB Cloud Manager

Create alert payload (in JSON format)

{
    "alertConfigId": "5770e05ae4b096e0e2c23ca0",
    "created": "2016-06-28T13:26:23Z",
    "eventTypeName": "MONITORING_AGENT_DOWN",
    "groupId": "5770d0ede4b0ca29d1781ccd",
    "id": "57727affe4b0a7dc53fb9429",
    "links": [
        {
            "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5770d0ede4b0ca29d1781ccd/alerts/57727affe4b0a7dc53fb9429",
            "rel": "self"
        }
    ],
    "status": "OPEN",
    "typeName": "AGENT",
    "updated": "2016-06-28T13:26:23Z"
}

Jira Service Management parses this payload as follows (in JSON format):

[
      "title": "[MongoDB Cloud] Alert for : MONITORING_AGENT_DOWN",
      "description": "
            Event Type : MONITORING_AGENT_DOWN
            Status : OPEN
            Created : 2016-06-28T13:26:23Z",
      "links": "https://cloud.mongodb.com/api/public/v1.0/groups/5770d0ede4b0ca29d1781ccd/alerts/57727affe4b0a7dc53fb9429"
]