Integrate with MongoDB Cloud Manager

What does the integration offer?

Compass has a Webhook integration with MongoDB Cloud Manager. Use the integration to send MongoDB Cloud Manager incidents to CompassAPI with detailed information. Compass 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 iOS and 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 Compass receives from MongoDB Cloud Manager.

How does the integration work?

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

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 Compass
Configure the integration in MongoDB Cloud Manager

Add a MongoDB Cloud Manager integration

In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well.

You can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add a MongoDB Cloud Manager integration in Compass, complete the following steps:

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 integration URL.
You will use this URL while configuring the integration in MongoDB Cloud Manager 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

To configure the integration in MongoDB Cloud Manager, complete the following steps:

In MongoDB Cloud Manager, go to Projects > Options > Integrations.
Scroll down to Webhook Settings and select Configure.
Paste the integration URL copied previously into Webhook URL.
Select Save.

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"
}

Payload parsed by Compass (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"
]

Operations