Marid Alert Action Data

Opsgenie passes alert activity data to various integrations. Below are listed some of the integrations that you can make use of this data:

For Webhook integration, alert action data is provided in the JSON body of the webhook request. For integrations that use Marid, the data is available to use in any script located under Marid's scripts directory.

Create

{
    "source":{
        "name":"web",
        "type":"API"
    },
    "alert":{
        "updatedAt":1420452193166002000,
        "tags": [
            "tag1", "tag2"
        ],
        "teams" : [
            "team1", "team2"   // ids of the teams assigned to this alert
        ],
        "recipients" : [
            "recipient1", "recipient2" // ids of the recipients assigned to this alert
        ]
        "message":" test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"Create",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Acknowledge

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452224764002246,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"Acknowledge",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

UnAcknowledge

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452224764002246,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"UnAcknowledge",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

AddTeam

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452256147001924,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":"",
        "team":"team2"
    },
    "action":"AddTeam",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

AddRecipient

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452274617001925,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":"",
        "recipient":"team2_escalation"
    },
    "action":"AddRecipient",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

AddNote

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452275002000962,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":"",
        "note":"note to test alert"
    },
    "action":"AddNote",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

AddTags

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452275002000962,
        "tags": [
            "tag1", "tag2", "tag3"
        ],
        "addedTags":"tag1,tag2,tag3",
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"AddTags",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

RemoveTags

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452275002000962,
        "tags": [
            "tag1", "tag2"
        ],
        "removedTags":"tag3",
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"RemoveTags",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Close

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452374669001603,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"Close",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Assign Ownership

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452374669001603,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":"",
        "owner" : "[email protected]"
    },
    "action":"AssignOwnership",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Take Ownership

{
   "integrationType":"Integration1",
   "alert":{
      "createdAt":1470226893192,
      "tinyId":"47",
      "alias":"8a745a79-3ed3-4044-8427-98e067c0623c",
      "alertId":"8a745a79-3ed3-4044-8427-98e067c0623c",
      "source":"[email protected]",
      "message":"message test",
      "userId":"ac6a9ab7-98fe-4256-8a0e-30dc082a55e7",
      "entity":"",
      "tags":[
      		"tag1","tag2"
      ],
      "updatedAt":1470383477928000335,
      "username":"[email protected]"
   },
   "integrationName":"Webhook",
   "action":"TakeOwnership",
   "integrationId":"fd8755c1-7a5e-4829-9ecc-8990e1a2eed3",
   "source":{
      "name":"",
      "type":"web"
   }
}

Delete

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "tinyId":"23",
        "alias":"aliastest",
        "entity":"",
        "message":"test alert",
        "updatedAt":1420452374669001603,
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "username":"[email protected]",
        "source":"[email protected]",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d"
    },
    "action":"Delete",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Escalate

The 'entity' property in escalationNotify can be one of the following values: "user, group, team, schedule".

The 'type' property in escalationNotify, can be "default" for the "user, group, team" entities and, can be "default, previous, next" for "schedule" entity.

{
    "escalationId":"51859f57-7fad-467b-ad79-59acbc69cb6a",
    "headers":{
        "foo":"bar"
    },
    "integrationName":"Webhook_Test",
    "escalationNotify":{
        "name":"[email protected]",
        "id":"64818849-71d6-40ce-87c6-ed5e588702fd",
        "type":"default",
        "entity":"user"
    },
    "integrationId":"868be72a-8015-432e-8b23-c1f7f4374baa",
    "escalationName":"test_esc",
    "alert":{
        "alertId":"7ba97e3a-d328-4b5e-8f9a-39e945a3869a"
    },
    "escalationTime":0,
    "action":"Escalate",
    "repeatCount":0
}

Update Priority

{
  "action": "UpdatePriority",
  "alert": {
    "alertId": "8809ea18-89ea-4e4e-9cca-8037fd745e102343",
    "message": "alert",
    "tags": [],
    "tinyId": "418",
    "source": "[email protected]",
    "entity": "",
    "alias": "8809ea18-89ea-4e4e-9cca-8037fd745e122220",
    "createdAt": 1512047424512,
    "updatedAt": 1512559548447000000,
    "username": "[email protected]",
    "userId": "486c4622-6db5-47220-b467-3ffb7s1be9b03",
    "insertedAt": 1512047424512000000,
    "priority": "P1",
    "oldPriority": "P3"
  },
  "source": {
    "name": "",
    "type": "web"
  },
  "integrationId": "1a423289-568a-468c-8a11-b1404edf0a832334534344",
  "integrationName": "Webhook1",
  "integrationType": "Webhook"
}

Update Description

{
  "action": "UpdateDescription",
  "alert": {
    "alertId": "0474d8d4-a4f2-4b2a-8b4d-1d5909faee41-1542176739551",
    "message": "test alert",
    "tags": [],
    "tinyId": "418",
    "entity": "",
    "alias": "8809ea18-89ea-4e4e-9cca-8037fd745e122220",
    "createdAt": 1512047424512,
    "updatedAt": 1512559548447000000,
    "username": "[email protected]",
    "userId": "486c4622-6db5-47220-b467-3ffb7s1be9b03",
    "description": "test description",
    "recipients": [],
    "teams": [],
    "actions": [],
    "details": {},
    "priority": "P3",
    "oldPriority": "P3",
    "source": "[email protected]"
  },
  "source": {
    "name": "",
    "type": "web"
  },
  "integrationId": "1a423289-568a-468c-8a11-b1404edf0a832334534344",
  "integrationName": "Webhook1",
  "integrationType": "Webhook"
}

Update Message

{
  "action": "UpdateMessage",
  "alert": {
    "alertId": "0474d8d4-a4f2-4b2a-8b4d-1d5909faee41-1542176739551",
    "message": "test alert 2",
    "tags": [],
    "tinyId": "418",
    "entity": "",
    "alias": "8809ea18-89ea-4e4e-9cca-8037fd745e122220",
    "createdAt": 1512047424512,
    "updatedAt": 1512559548447000000,
    "username": "[email protected]",
    "userId": "486c4622-6db5-47220-b467-3ffb7s1be9b03",
    "description": "test description",
    "recipients": [],
    "teams": [],
    "actions": [],
    "details": {},
    "priority": "P3",
    "oldPriority": "P3",
    "source": "[email protected]"
  },
  "source": {
    "name": "",
    "type": "web"
  },
  "integrationId": "1a423289-568a-468c-8a11-b1404edf0a832334534344",
  "integrationName": "Webhook1",
  "integrationType": "Webhook"
}

A custom action with name "TestAction"

{
    "source":{
        "name":"",
        "type":"web"
    },
    "alert":{
        "updatedAt":1420452275002000962,
        "tags": [
            "tag1", "tag2"
        ],
        "message":"test alert",
        "username":"[email protected]",
        "alertId":"052652ac-5d1c-464a-812a-7dd18bbfba8c",
        "source":"[email protected]",
        "alias":"aliastest",
        "tinyId":"23",
        "createdAt":1420452191104,
        "userId":"daed1180-0ce8-438b-8f8e-57e1a5920a2d",
        "entity":""
    },
    "action":"TestAction",
    "integrationId":"37c8f316-17c6-49d7-899b-9c7e540c048d",
    "integrationName":"Integration1"
}

Updated about a month ago

Marid Alert Action Data


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.