Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Create a Configuration for a Third-Party Service Integration

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Syntax

POST /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}

Request Path Parameters

Parameter Necessity Description
{PROJECT-ID} Required Project identifier.
{INTEGRATION-TYPE} Required

Third-party service identifier. Accepted values are:

  • DATADOG
  • HIP_CHAT
  • PAGER_DUTY
  • SLACK
  • NEW_RELIC
  • OPS_GENIE
  • VICTOR_OPS
  • FLOWDOCK
  • WEBHOOK

Request Query Parameters

Name Type Necessity Description Default
pageNum number Optional One-based integer that returns a subsection of results. 1
itemsPerPage number Optional Number of items to return per page, up to a maximum of 500. 100
pretty boolean Optional Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the query.

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

false

Request Body Parameters

The request body should be a single integration view (like a JSON configuration object) for a single third-party service to add to the project. Always include a type property equal to the third-party service INTEGRATION_TYPE.

Service Configuration Options
PagerDuty

You must provide the following fields when you configure a PagerDuty integration:

Property Description
type PAGER_DUTY
serviceKey

Your Integration Key.

Important

Changing the Integration Key doesn’t change any alerts that use this integration. Those alerts still use the previous Integration Key.

Remove and re-add each PagerDuty notification(s) to use the new key.

Note

PagerDuty decommissioned their REST API v1 key in October 2018. If you have a v1 key, you can continue to use that key with Ops Manager. All new PagerDuty keys use their REST API v2, but Ops Manager does not support their v2 keys. If you don’t have their REST API v1 key, use the PagerDuty Events API v1 instead.

Slack

Important

Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the MongoDB Atlas third-party service integrations page.

Legacy tokens will soon no longer be supported.

You must provide the following fields when you reconfigure an existing Slack integration:

Property Description
type SLACK
apiToken Your API Token.
teamName Your team name.

You may also include the following fields:

Property Description
channelName The channel name to reconfigure.
Datadog

You must provide the following fields when you configure a Datadog integration:

Property Description
type DATADOG
apiKey Your API Key.
HipChat

You must provide the following fields when you configure a HipChat integration:

Property Description
type HIP_CHAT
notificationToken Notification token for your HipChat user account.
roomName Your HipChat room name.
Opsgenie

You must provide the following fields when you configure a Opsgenie integration:

Property Description
type OPS_GENIE
apiKey Your API Key.
region Indicates which API URL is used, either US or EU. Opsgenie will use US by default.

Note

To set region to EU, you must set a customer setting of opsgenie.api.url.

VictorOps

You must provide the following fields when you configure a VictorOps integration:

Property Description
type VICTOR_OPS
apiKey Your API Key.

You may also include the following fields:

Property Description
routingKey An optional field for your Routing Key.
Flowdock

You must provide the following fields when you configure a VictorOps integration:

Property Description
type FLOWDOCK
flowName Your Flowdock Flow name.
apiToken Your API Token.
orgName Your Flowdock organization name.
Webhook Settings

You must provide the following fields when you configure webhook settings:

Property Description
type WEBHOOK
url Your webhook URL.

You may also include the following fields:

Property Description
secret An optional field for your webhook secret.

Response Elements

The response includes a results array which lists all third-party integration configurations for the project as objects, and a totalCount of the services integrated with the project.

Each third-party integration configuration object includes a type property equal to its own integration type ("type": "PAGER_DUTY" for the PagerDuty service). Additionally, each third-party service configuration object provides details specific to that service. The following lists the properties returned for each third-party service configuration object:

Service Result
PagerDuty

A returned PagerDuty integration configuration object contains the following fields:

Property Description
type PAGER_DUTY
serviceKey Your Service Key.
Slack

A returned Slack integration configuration object contains the following fields:

Property Description
type SLACK
apiToken Your API Token.
teamName Your team name. This field may not be present with a legacy Slack integration.
channelName The configured Slack channel name. An empty string if the value is not set.
Datadog

A returned Datadog integration configuration object contains the following fields:

Property Description
type DATADOG
apiKey Your API Key.
HipChat

A returned HipChat integration configuration object contains the following fields:

Property Description
type HIP_CHAT
notificationToken Notification token for your HipChat user account.
roomName Your HipChat room name.
Opsgenie

A returned Opsgenie integration configuration object contains the following fields:

Property Description
type OPS_GENIE
apiKey Your API Key.
region Indicates which API URL to use, either US or EU. Opsgenie defaults to US.

Note

To set region to EU, you must set a customer setting of opsgenie.api.url.

VictorOps

A returned VictorOps integration configuration object contains the following fields:

Property Description
type VICTOR_OPS
apiKey Your API Key.

The configuration object may also contain the following fields, depending on your configuration:

Property Description
routingKey An optional field returned if you have a Routing Key configured.
Flowdock

A returned Flowdock integration configuration object contains the following fields:

Property Description
type FLOWDOCK
flowName Your Flowdock Flow name.
apiToken Your API Token.
orgName Your Flowdock organization name.
Webhook Settings

A returned webhook configuration object contains the following fields:

Property Description
type WEBHOOK
url Your webhook URL.

The configuration object may also contain the following fields, depending on your configuration:

Property Description
secret An optional field returned if your webhook is configured with a secret.

Example Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/FLOWDOCK" \
     --data '
       {
         "type": "FLOWDOCK",
         "flowName": "myFlowName",
         "apiToken": "112233",
         "orgName": "myOrg"
       }'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/FLOWDOCK?pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "serviceKey": "112233",
      "type": "PAGER_DUTY"
    },
    {
      "apiToken": "112233",
      "channelName": "My Channel",
      "teamName": "My Team",
      "type": "SLACK"
    },
    {
      "apiToken": "112233",
      "flowName": "myFlowName",
      "orgName": "myOrg",
      "type": "FLOWDOCK"
    }
  ],
  "totalCount": 3
 }