Endpoint
/api/v2/tenants/{tenantId}/integrations/install/EMAILALERTS
Path Parameters
tenantId
string

alertSource
object

Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.

alertSource.displayName
alertSource.id
alertSource.name
alertSource.techUid
category
string

Category describes the behavior of custom integration. Applicable only for Custom Integration installation. Example: If monitoring is selected as category, the integration will work as monitoring integration.

description
string

direction
string

Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.

displayName
string

Name used to identify the integration.

emailAddress
string

emailProps
array

emailProps.identifier
Unique value of a set.Email data identifies the set with this identifier and parses with the respective parsing conditions.
emailProps.identifierSource
Source for considering the unique value. Supported Values: EMAIL_SUBJECT, EMAIL_CONTENT, DEFAULT_VALUE.
emailProps.name
Name of parsing conditions set.
emailProps.properties
id
string

inboundConfig
object

inboundConfig .authentication
inboundConfig .mapAttributes
installedBy
string

installedTime
time

integration
object

integration.id
integration.multipleInstallations
integration.name
outboundConfig
object

outboundConfig .baseNotifier
The fields are required unless specific to an `authType`.
outboundConfig .mapAttributes
parentIntg
object

parentIntg.id
status
string

ticketType
string

OpsRamp supports the following ticket types:

{
  "displayName": "Email Alerts Integration",
  "emailProps": [
    {
      "identifier": "identify",
      "identifierSource": "EMAIL_CONTENT",
      "name": "test set 1",
      "properties": [
        {
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "endValue": "value2",
            "operator": "BETWEEN",
            "startValue": "value1"
          },
          "defaultValue": "OK",
          "name": "Alert State"
        },
        {
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "endValue": "value2",
            "operator": "BETWEEN",
            "startValue": "value1"
          },
          "name": "Service Name"
        },
        {
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "endValue": "value2",
            "operator": "BETWEEN",
            "startValue": "value1"
          },
          "name": "Device Host Name"
        }
      ]
    }
  ],
  "logo": {
    "file": "zWc/aG7Ws5nifQL0cHF6fxW8vRwcXp/Ffyky7HaICAgIXNbBkr5hzWwZK+YY9FmJ/FLppwpn45SvJ2S4oBaNgBAQEBAQEBAQEBAQEBAQEBAQf//Z ",
    "name": "logo.png"
  }
}

Responses

OK

alertSource
object

Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.

alertSource.displayName
alertSource.id
alertSource.name
alertSource.techUid
category
string

Category describes the behavior of custom integration. Applicable only for Custom Integration installation. Example: If monitoring is selected as category, the integration will work as monitoring integration.

description
string

direction
string

Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.

displayName
string

Name used to identify the integration.

emailAddress
string

emailProps
array

emailProps.identifier
Unique value of a set.Email data identifies the set with this identifier and parses with the respective parsing conditions.
emailProps.identifierSource
Source for considering the unique value. Supported Values: EMAIL_SUBJECT, EMAIL_CONTENT, DEFAULT_VALUE.
emailProps.name
Name of parsing conditions set.
emailProps.properties
id
string

inboundConfig
object

inboundConfig .authentication
inboundConfig .mapAttributes
installedBy
string

installedTime
time

integration
object

integration.id
integration.multipleInstallations
integration.name
outboundConfig
object

outboundConfig .baseNotifier
The fields are required unless specific to an `authType`.
outboundConfig .mapAttributes
parentIntg
object

parentIntg.id
status
string

ticketType
string

OpsRamp supports the following ticket types:

{
  "displayName": "email alerts test from api try 44",
  "emailAddress": "alerts@5JHqWy4h34xXDwN2gYFtmaYx.opsramp.com",
  "emailProps": [
    {
      "identifier": ".",
      "identifierSource": "EMAIL_CONTENT",
      "name": "test set 1",
      "properties": [
        {
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "endValue": "value2",
            "operator": "BETWEEN",
            "startValue": "value1"
          },
          "defaultValue": "OK",
          "name": "Alert State"
        },
        {
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "endValue": "value2",
            "operator": "BETWEEN",
            "startValue": "value1"
          },
          "name": "Service Name"
        },
        {
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "endValue": "value2",
            "operator": "BETWEEN",
            "startValue": "value1"
          },
          "name": "Device Host Name"
        }
      ]
    }
  ],
  "id": "INTG-d9b99937-7906-42c7-955c-68a237144ac7",
  "integration": {
    "id": "Email Alerts",
    "name": "Email Alerts"
  }
}