Integrate with APImetrics

This article highlights a new alerting feature that's natively available in Jira Service Management which is gradually rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

What does the integration offer?

Use Jira Service Management's APImetrics Integration to forward APImetrics notifications to Jira Service Management. Jira Service Management determines the right people to notify based on on-call schedules– notifies via email, text messages (SMS), phone calls, iOS & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

When an API call error or warning is captured in APImetrics, it creates an alert in Jira Service Management.

Set up the integration

APImetrics is an API integration. Setting it up involves the following steps:

Add an APImetrics integration in Jira Service Management
Configure the integration in APImetrics

Add an APImetrics integration

Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be either on Premium or Enterprise.

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

To add an APImetrics integration in Jira Service Management, 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 “APImetrics”.
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 URL.
You will use this URL while configuring the integration in APImetrics 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 APImetrics

To configure the integration in APImetrics, complete the following steps:

In APImetrics, go to Alerts & Webhooks.
Select "Generic" for Type.
Leave "Enabled" selected.
Leave "All selected" selected for Trigger alerts.
Paste the integration URL previously copied from Jira Service Management into API Url.
Select Save.

Sample webhook message from APImetrics

JSON

{
  "response_size": 0,
  "location_id": "public_googleuscentral1",
  "result_class": "WARNING",
  "call_id": "agpzfnZpYXRlc3RzchcLEgpUZXN0U2V0dXAyGICAsJ7Bl7UKDA",
  "result_url": "http://client.apimetrics.io/tests/result/agpzfnZpYXRlc3RzchgLEgtUZXN0UmVzdWx0MxiAgLCe1LCjCQw/",
  "result": "DOWNLOAD_ERROR",
  "context": {
    "_result_category": "WARNING",
    "_result_streak": 1,
    "_notification": {
      "category": "WARNING",
      "owners": [
        "agpzfnZpYXRlc3RzchELEgRVc2VyGICAsO6ThqAKDA"
      ],
      "viewed_by": [],
      "title": "[WARNING]: APImetrics: All Failures: Test 2018-05-11 13:46:46.075200",
      "created": "2018-05-11T13:47:06.393630Z",
      "last_update": "2018-05-11T13:47:06.484100Z",
      "references": [
        "agpzfnZpYXRlc3RzchcLEgpUZXN0U2V0dXAyGICAsJ7Bl7UKDA",
        "agpzfnZpYXRlc3RzchgLEgtUZXN0UmVzdWx0MxiAgLCe1LCjCQw"
      ],
      "description": "\n<p>\nAPI Call <a href=\"http://client.apimetrics.io/tests/test/agpzfnZpYXRlc3RzchcLEgpUZXN0U2V0dXAyGICAsJ7Bl7UKDA/\">\"Test 2018-05-11 13:46:46.075200\"</a> has failed :\n<ul>\n<li><b>We could not connect to the API.</b></li>\n\n<li>Calling GET https://fhjpvdm2yutb.runscope.net%09</li>\n<li>Checking for connection issue...</li>\n<li>... no problem found.</li>\n<li>Couldn&#39;t resolve host. The given remote host was not resolved.</li>\n<li>We could not connect to the API.</li>\n<li>Couldn&#39;t resolve host &#39;fhjpvdm2yutb.runscope.net%09&#39;</li>\n\n</ul>\n</p>\n\n\n</p>\n\n<p>\nView details here:\n<a href=\"http://client.apimetrics.io/tests/result/agpzfnZpYXRlc3RzchgLEgtUZXN0UmVzdWx0MxiAgLCe1LCjCQw/\">http://client.apimetrics.io/tests/result/agpzfnZpYXRlc3RzchgLEgtUZXN0UmVzdWx0MxiAgLCe1LCjCQw/</a>\n</p>\n\n<p>Sincerely,<br>\nAPImetrics Team\n</p>\n"
    }
  },
  "result_id": "agpzfnZpYXRlc3RzchgLEgtUZXN0UmVzdWx0MxiAgLCe1LCjCQw",
  "call_url": "http://client.apimetrics.io/tests/test/agpzfnZpYXRlc3RzchcLEgpUZXN0U2V0dXAyGICAsJ7Bl7UKDA/",
  "response_time": 0
}

Was this helpful?

It wasn't accurate

It wasn't clear

It wasn't relevant

Still need help?

The Atlassian Community is here for you.

Ask the Community