Documentation is now available for the Fall 2020 Update release!

Update installed integrations

This endpoint is used to update the details of an installed integration.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

Sample URLs

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761

Parameters

FieldSubfieldsData TypeDescription
    inboundConfig1. authentication

authType

StringAuthentication type: WEBHOOK, OAUTH2
Example: OAUTH2
2. mapAttributes: Map third-party attributes with OpsRamp attributes. Below are the map attributes.
nameStringOpsRamp attribute name.
Example: Priority
thirdPartyAttrNameStringThird-party attribute name.
Example: Severity
entityTypeStringOpsRamp Entity type.ALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK
Example: INCIDENT
thirdPartyEntityTypeStringThird-party entity type.
Example: Ticket
attrValues
  • attrValue
  • tenantAttrValue
String
  1. OpsRamp attribute value.
    Example: Open
  2. Tenant attribute value.
    Example: In Progress
         outboundConfig1. mapAttributes: Map third-party attributes with OpsRamp attributes. Below are the map attributes.
nameStringOpsRamp attribute name.
Example: Priority
thirdPartyAttrNameStringThird-party attribute name.
Example: Severity
entityTypeStringOpsRamp Entity type.PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK
Example: ALERT
thirdPartyEntityTypeStringThird-party entity type.
Example: Ticket
attrValues
  • attrValue
  • tenantAttrValue
String
  1. OpsRamp attribute value.
    Example: Close
  2. Tenant attribute value.
    Example: Completed
2. notifier: Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes mentioned below.
typeStringNotifer type. SOAP_API, REST_API
Example: REST_API
authTypeStringAuthentication type. NONE, OAUTH2
Example: OAUTH2
grantTypeStringGrant type. CLIENT_CREDENTIALS, PASSWORD_CREDENTIALS, REFRESH_TOKEN. Valid only if authentication type is OAUTH2.
Example: CLIENT_CREDENTIALS
userNameStringProvide user credentials of the person sending the notifier. Valid only when authentication type is OAUTH2 and grant type is PASSWORD_CREDENTIALS/REFRESH_TOKEN.
passwordStringProvide password of the user account. Valid only when authentication type is OAUTH2 and grant type is PASSWORD_CREDENTIALS/REFRESH_TOKEN.
apiKeyStringAPI key. Valid only if authentication type is OAUTH2.
apiSecretStringAPI secret. Valid only if authentication type is OAUTH2.
accessTokenURIStringURI used to get the access token.
alertSourceString(Optional) Source of alert. Applicable to Email Alert and Custom Integration Updates for Monitoring Integration category. View Alert Technologies API to know about the list of allowed Alert Sources.

Status code

200 OK

Sample request

{
	"inboundConfig": {
		"authentication": {
			"authType": "WEBHOOK"
		},
		"mapAttributes": [{
				"name": "Status",
				"thirdPartyAttrName": "Status",
				"entityType": "SERVICEREQUEST",
				"thirdPartyEntityType": "REQUEST",
				"attrValues": [{
						"attrValue": "Open",
						"thirdPartyAttrValue": "In Progress"
					},
					{
						"attrValue": "Closed",
						"thirdPartyAttrValue": "Completed"
					}
				]
			},
			{
				"name": "Status",
				"thirdPartyAttrName": "Status",
				"entityType": "INCIDENT",
				"thirdPartyEntityType": "TICKET",
				"attrValues": [{
						"attrValue": "Open",
						"thirdPartyAttrValue": "In Progress"
					},
					{
						"attrValue": "Closed",
						"thirdPartyAttrValue": "Completed"
					}
				]
			},
			{
				"name": "Priority",
				"thirdPartyAttrName": "severity",
				"entityType": "INCIDENT",
				"thirdPartyEntityType": "TICKET",
				"attrValues": [{
						"attrValue": "High",
						"thirdPartyAttrValue": "Maximum"
					},
					{
						"attrValue": "Low",
						"thirdPartyAttrValue": "Minimum"
					}
				]
			},
			{
				"name": "Priority",
				"thirdPartyAttrName": "Severity",
				"entityType": "SERVICEREQUEST",
				"thirdPartyEntityType": "REQUEST",
				"attrValues": [{
						"attrValue": "High",
						"thirdPartyAttrValue": "Maximum"
					},
					{
						"attrValue": "Low",
						"thirdPartyAttrValue": "Minimum"
					}
				]
			}
		]
	},
	"outboundConfig": {
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "Status",
			"entityType": "INCIDENT",
			"thirdPartyEntityType": "Ticket",
			"attrValues": [{
					"attrValue": "Ok",
					"thirdPartyAttrValue": "Good"
				},
				{
					"attrValue": "Critical",
					"thirdPartyAttrValue": "Bad"
				}
			]
		}],
		"baseNotifier": {
			"type": "REST_API",
			"baseURI": "www.google.com",
			"authType": "OAUTH2",
			"grantType": "PASSWORD",
			"userName": "testUser",
			"password": "*************",
			"accessTokenURI": "www.token.com/cred",
			"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"apiSecret": "***************************"
		}
	}
}

Sample response

{
	"id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
	"integration": {
		"id": "CASERVICEDESK",
		"name": "Service Desk"
	},
	"inboundConfig": {
		"authentication": {
			"authType": "WEBHOOK",
			"token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
		},
		"mapAttributes": [{
				"name": "Status",
				"attrName": "ServiceRequest.status.name",
				"thirdPartyAttrName": "Status",
				"entityType": "SERVICEREQUEST",
				"thirdPartyEntityType": "REQUEST",
				"attrValues": [{
						"attrValue": "Open",
						"thirdPartyAttrValue": "In Progress"
					},
					{
						"attrValue": "Closed",
						"thirdPartyAttrValue": "Completed"
					}
				]
			},
			{
				"name": "Status",
				"attrName": "incident.status.name",
				"thirdPartyAttrName": "Status",
				"entityType": "INCIDENT",
				"thirdPartyEntityType": "Ticket",
				"attrValues": [{
						"attrValue": "Ok",
						"thirdPartyAttrValue": "Good"
					},
					{
						"attrValue": "Critical",
						"thirdPartyAttrValue": "Bad"
					},
					{
						"attrValue": "Open",
						"thirdPartyAttrValue": "In Progress"
					},
					{
						"attrValue": "Closed",
						"thirdPartyAttrValue": "Completed"
					}
				]
			},
			{
				"name": "Priority",
				"attrName": "incident.priority.name",
				"thirdPartyAttrName": "Severity",
				"entityType": "INCIDENT",
				"thirdPartyEntityType": "TICKET",
				"attrValues": [{
						"attrValue": "High",
						"thirdPartyAttrValue": "Maximum"
					},
					{
						"attrValue": "Low",
						"thirdPartyAttrValue": "Minimum"
					}
				]
			},
			{
				"name": "Priority",
				"attrName": "serviceRequest.priority.name",
				"thirdPartyAttrName": "Severity",
				"entityType": "SERVICEREQUEST",
				"thirdPartyEntityType": "REQUEST",
				"attrValues": [{
						"attrValue": "High",
						"thirdPartyAttrValue": "Maximum"
					},
					{
						"attrValue": "Low",
						"thirdPartyAttrValue": "Minimum"
					}
				]
			}
		]
	},
	"outboundConfig": {
		"baseNotifier": {
			"baseURI": "www.google.com",
			"authType": "OAUTH2",
			"grantType": "PASSWORD",
			"userName": "testUser",
			"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"accessTokenURI": "www.token.com/cred"
		},
		"mapAttributes": [{
			"name": "Status",
			"attrName": "incident.status.name",
			"thirdPartyAttrName": "stats",
			"entityType": "INCIDENT",
			"thirdPartyEntityType": "Ticket",
			"attrValues": [{
					"attrValue": "Ok",
					"thirdPartyAttrValue": "Good"
				},
				{
					"attrValue": "Critical",
					"thirdPartyAttrValue": "Bad"
				},
				{
					"attrValue": "Ok",
					"thirdPartyAttrValue": "Good"
				},
				{
					"attrValue": "Critical",
					"thirdPartyAttrValue": "Bad"
				}
			]
		}]
	}
}