API Integration Guide

The API Integration allows you to send alerts from any system to Xurrent IMR and trigger and resolve alerts.

To integrate any Application's Webhook with Xurrent IMR, complete the following steps:

In Xurrent IMR:

1. To add a new API integration, go to Teams on Xurrent IMR and click on the team you want to add the integration to.
2. Next, go to Services and click on the relevant Service.
3. Go to Integrations and then Add New Integration. Give it a name and select the application API from the dropdown menu.
4. Go to Configure under your integrations and copy the Integration key generated.

In your Application/Service:

5. To create an alert from your application, send a post request to:
   https://events.zenduty.com/api/events/<integration-key>/

• Here, the integration key that was copied earlier is to be used.

6. Add post parameters by following the table below :

• In the headers, the Content type should be set to "application/json"
• 'Content-Type: application/json'
• For a more detailed explanation of the fields, click here.
• Sample Payload for creating an incident with a critical incident

{
  "alert_type": "critical",
  "message": "This is a sample alert from API integration",
  "summary": "This is the incident summary for the API integration",
  "entity_id": 12345,
  "payload": {
    "status": "ACME Payments are failing",
    "severity": "1",
    "project": "kubeprod"
  },
  "urls": [
    {
      "link_url": "https://www.example.com/alerts/12345/",
      "link_text": "Alert URL"
    }
  ]
}

The alerts are bound into incidents by their entity ID. If you'd like to resolve the exising incident, make sure to change the alert type to 'Resolved' and keep the entity ID intact.

For example, you can send the below payload to resolve the above sample incident

{
  "alert_type": "resolved",
  "message": "This is a sample alert from API integration",
  "summary": "This is the incident summary for the API integration",
  "entity_id": 12345,
  "payload": {
    "status": "ACME Payments are failing",
    "severity": "1",
    "project": "kubeprod"
  },
  "urls": [
    {
      "link_url": "https://www.example.com/alerts/12345/",
      "link_text": "Alert URL"
    }
  ]
}

• For cURL requests:

 curl -X POST https://events.zenduty.com/api/events/[integration-key]/ -H 'Content-Type: application/json' -d '{"alert_type":"critical", "message": "This is a sample alert from API integration", "summary": "This is the incident summary for the API integration", "entity_id":"some_entity_id", "urls":[{"link_url": "https://www.example.com/alerts/1234/","link_text": "Alert URL"}]}'

Migration Steps

1. Migrate Using the Button

On the API Integration page, click the "Migrate to Generic Integration" button. This will automatically convert your current API Integration to a Generic Integration.

2. Alert Rules Compatibility

All your existing alert rules will be automatically updated to work with the new Generic Integration. No manual changes are needed for alert rule logic.

Old Alert rules:

Updated alert rules:

3. Update the API Endpoint URL

Update your integration endpoint in all systems:

• Old URL Format:
• New URL Format:

Make sure to replace <integration-key> and <account_identifer> with your actual integration key.

Note: If you are using the API response, please read this blog post for more details.