Install email integration

This endpoint is used to install Email alerts and email request integration.

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/{intgId}

Sample URLs

To install email alerts:

https://{api-url}/api/v2/tenants/client_8/integrations/install/Email Alerts

To install email request:

https://{api-url}/api/v2/tenants/client_9/integrations/install/EMAILINCIDENTS

Parameters

Field	SubField	Data Type	Description
displayName	NA	String	Display name for the integration.
logo	name	String	Logo name for the integration.
logo	file	String	Base64 code file of the logo.
ticketType	NA	String	OpsRamp supports the following ticket types: INCIDENT SERVICEREQUEST CHANGE
emailProps	1. name	String	Name of parsing conditions set.
	2. identifier	String	Unique value of a set.Email data identifies the set with this identifier and parses with the respective parsing conditions.
	3. identifierSource	String	Source for considering the unique value. Supported Values: EMAIL_SUBJECT, EMAIL_CONTENT, DEFAULT_VALUE.
	4. properties: Properties for the email
	1. name	String	Property name. Example: Alert State
	2. defaultValue	String	Default Value is considered if any of the properties do not match with the respective configured values.
	3. condition: Conditions to filter the values from the email data
	contentSource	String	Source from which the values should be considered. Supported Values: EMAIL_SUBJECT, EMAIL_CONTENT, DEFAULT_VALUE.
	operator	String	Unique keys required to filter the values from the content source. Supported Values: BETWEEN, BEFORE, AFTER, MATCHES.
	startValue	String	Initial value.
	endValue	String	End value. Start value and End value are filter properties. These properties are used to filter a certain value between the start value and end value.
	regexStr	String	Regex string. Provide a regex string of the value that considered from the content source.
	4. propertyMappings: Map third-party attributes with OpsRamp attributes
	attrValues attrValue thirdPartyAttrValue	String	Attribute values: OpsRamp attribute values Third-party attribute values

NA indicates that the value is not applicable.

Status code

200 OK

Install Email Alert Integration

OpsRamp processes all incoming Alert emails. Apply user-defined rules to create, acknowledge, and close alerts incoming emails.

Convert image to Base64 and enter the code in file field as shown in the following sample request.

Sample request

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

Sample response

{
	"id": "INTG-d9b99937-7906-42c7-955c-68a237144ac7",
	"displayName": "email alerts test from api try 44",
	"integration": {
		"id": "Email Alerts",
		"name": "Email Alerts"
	                },
        "emailAddress": "alerts@5JHqWy4h34xXDwN2gYFtmaYx.opsramp.com",

        "emailProps": [{
		"name": "test set 1",
		"identifier": ".",
		"identifierSource": "EMAIL_CONTENT",
		"properties": [{
				"name": "Alert State",
				"defaultValue": "OK",
				"condition": {
					"contentSource": "EMAIL_CONTENT",
					"operator": "BETWEEN",
					"startValue": "value1",
					"endValue": "value2"
				            }
			        },
			       {
				"name": "Service Name",
				"condition": {
					"contentSource": "EMAIL_CONTENT",
					"operator": "BETWEEN",
					"startValue": "value1",
					"endValue": "value2"
				             }
			        },
			        {
				"name": "Device Host Name",
				"condition": {
					"contentSource": "EMAIL_CONTENT",
					"operator": "BETWEEN",
					"startValue": "value1",
					"endValue": "value2"
				              }
			        }]
	       }]
}

Install Email Request Integration

Email request integration creates tickets in OpsRamp via Email.

Convert image to Base64 and enter the code in file field as shown in the following sample request.

Sample request

{
	"displayName": "email request test",
	"ticketType": "INCIDENT",
	"logo": {
		"name": "test.png",
		"file": "zWc/aG7Ws5nifQL0cHF6fxW8vRwcXp/Ffyky7HaICAgIXNbBkr5hzWwZK+YY9FmJ/FLppwpn45SvJ2S4oBaNgBAQEBAQEBAQEBAQEBAQEBAQf//Z"
	},
	"emailProps": [{
		"properties": [{
				"name": "Priority",
				"defaultValue": "Low",
				"condition": {
					"contentSource": "EMAIL_CONTENT",
					"operator": "BETWEEN",
					"startValue": "value1",
					"endValue": "value2"
				},
				"propertyMappings": {
					"attrValues": [{
						"attrValue": "Low",
						"thirdPartyAttrValue": "myval"
					}]
				}
			},
			{
				"name": "Subject",
				"value": "Email Subject"
			},
			{
				"name": "Description",
				"value": "Email Description"
			},
			{
				"name": "Allow anonymous user",
				"value": "true"
			}
		]
	}]
}

Sample response

{
	"id": "INTG-02d467ee-41f2-4d1e-9c55-e8365b421f21",
	"displayName": "email incidents test",
	"integration": {
		"id": "EMAILINCIDENTS",
		"name": "Email Requests"
	},
        "emailAddress": "alerts@5JHqWy4h34xXDwN2gYFtmaYx.opsramp.com",
	"emailProps": [{
		"properties": [{
				"name": "Allow anonymous user",
				"value": "true"
			},
			{
				"name": "Subject",
				"value": "Email Subject"
			},
			{
				"name": "Description",
				"value": "Email Description"
			},
			{
				"name": "Priority",
				"defaultValue": "Low",
				"condition": {
					"contentSource": "EMAIL_CONTENT",
					"operator": "BETWEEN",
					"startValue": "value1",
					"endValue": "value2"
				},
				"propertyMappings": {
					"name": "Priority",
					"attrName": "incident.priority.name",
					"entityType": "INCIDENT",
					"attrValues": [{
						"attrValue": "Low",
						"thirdPartyAttrValue": "myval"
					}]
				}
			}
		]
	}]
}