Documentation is now available for the Fall 2020 Update release!

Collaboration Integrations

This endpoint is used to install collaboration integrations supported by OpsRamp.

Leave Feedback

URL

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

Sample URLs

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

The following collaboration Integrations are supported:

CollaborationCollaboration
AutotaskJIRA
AWS SupportNetEnrich Ticketing System
BMC RemedyPMG
CA Service DeskServiceNow
CherwellSlack
ConnectWiseSolutions Desk
Email RequestZendesk
Freshservice

Parameters

All fields are mandatory:

FieldSub-FieldsData TypeValuesDescription
inboundConfigmapAttributes
1. nameStringNAOpsRamp attribute name.
2. tenantAttrNameStringNAThird-party attribute name.
3. entityTypeStringALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASKOpsRamp entity type.
4. tenantEntityTypeStringNAThird-party entity type.
5. attrValues
  • attrValue
  • tenantAttrValue
StringNAMapping attribute values:
  • OpsRamp mapping attribute value
  • Third-party mapping attribute mapping value
outboundConfig1. mapAttributes
1. nameStringNAOpsRamp attribute name.
2. tenantAttrNameStringNAThird-party attribute name.
3.  entityTypeStringALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASKOpsRamp entity type.
4. tenantEntityTypeStringNAThird-party entity type.
5. attrValues
  • attrValue
  • tenantAttrValue
StringNAMapping attribute values:
  • OpsRamp mapping attribute value
  • Third-party mapping attribute mapping value
2. notifier
1. typeStringREST_API, SOAP_APINotification type.
2. authTypeStringNONE, BASIC, OAUTH2Authentication type.
3. grantTypeStringCLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKENGrant type for notification.
4. userNameStringNAUsername.Mandatory when authType is BASIC/OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
5. passwordStringNAPasswordMandatory when authType is BASIC/OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
6. apiKeyStringNAAPI Key.Mandatory if authType is OAUTH2.
7. apiSecretStringNAAPI Secret.Mandatory if authType is OAUTH2.
8. accessTokenURIStringNAAccess Token URLMandatory if authType is OAUTH2.

NA indicates that the value is not applicable.

Install Integration with Authentication Details

Sample request

{
	"inboundConfig" : {
		"authentication" : {
			"authType" : "WEBHOOK"
		}
	}
}

Sample response

{
	"id" : "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
	"integration" : {
		"id" : "CASERVICEDESK",
		"name" : "Service Desk"
	},
	"inboundConfig" : {
		"authentication" : {
			"authType" : "WEBHOOK",
			"token" : "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
		}
	}
}

Install Integration with Inbound Configuration Details

Sample request

{
	"inboundConfig" : {
		"authentication" : {
			"authType" : "WEBHOOK"
		},
		"mapAttributes" : [
			{
				"name" : "Status",
				"thirdPartyAttrName" : "Status",
				"entityType" : "SERVICEREQUEST",
				"thirdPartyEntityType" : "SRQ",
				"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" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			},
			{
				"name" : "Priority",
				"thirdPartyAttrName" : "severity",
				"entityType" : "SERVICEREQUEST",
				"thirdPartyEntityType" : "SRQ",
				"attrValues" : [
					{
						"attrValue" : "High",
						"thirdPartyAttrValue" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			}
		]
	}
}

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" : "SRQ",
				"attrValues" : [
					{
						"attrValue" : "Open",
						"thirdPartyAttrValue" : "In Progress"
					},
					{
						"attrValue" : "Closed",
						"thirdPartyAttrValue" : "Completed"
					}
				]
			},
			{
				"name" : "Status",
				"attrName" : "incident.status.name",
				"thirdPartyAttrName" : "stats",
				"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" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			},
			{
				"name" : "Priority",
				"attrName" : "serviceRequest.priority.name",
				"thirdPartyAttrName" : "severity",
				"entityType" : "SERVICEREQUEST",
				"thirdPartyEntityType" : "SRQ",
				"attrValues" : [
					{
						"attrValue" : "High",
						"thirdPartyAttrValue" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			}
		]
	}
}

Install Integration with Outbound Configuration Details

Sample request

{
	"outboundConfig" : {
		"mapAttributes" : [
			{
				"name" : "Status",
				"thirdPartyAttrName" : "stats",
				"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" : "pk",
			"accessTokenURI" : "www.token.com/cred",
			"apiKey" : "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"apiSecret" : "asdfgnasinfpaiwerpfawpeojporwjaeprfwpejprwje"
		}
	}
}

Sample response

{
	"id" : "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
	"integration" : {
		"id" : "CASERVICEDESK",
		"name" : "Service Desk"
	},
	"outboundConfig" : {
		"baseNotifier" : {
			"baseURI" : "www.google.com",
			"authType" : "OAUTH2",
			"grantType" : "PASSWORD",
			"userName" : "testUser",
			"apiKey" : "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"accessTokenURL" : "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"
					}
				]
			}
		]
	}
}

Install Integration with Inbound and Outbound Configuration Details

Sample request

{
	"inboundConfig" : {
		"authentication" : {
			"authType" : "WEBHOOK"
		},
		"mapAttributes" : [
			{
				"name" : "Status",
				"thirdPartyAttrName" : "Status",
				"entityType" : "SERVICEREQUEST",
				"thirdPartyEntityType" : "SRQ",
				"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" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			},
			{
				"name" : "Priority",
				"thirdPartyAttrName" : "severity",
				"entityType" : "SERVICEREQUEST",
				"thirdPartyEntityType" : "SRQ",
				"attrValues" : [
					{
						"attrValue" : "High",
						"thirdPartyAttrValue" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			}
		]
	},
	"outboundConfig" : {
		"mapAttributes" : [
			{
				"name" : "Status",
				"thirdPartyAttrName" : "stats",
				"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" : "pk",
			"accessTokenURL" : "www.token.com/cred",
			"apiKey" : "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"apiSecret" : "asdfgnasinfpaiwerpfawpeojporwjaeprfwpejprwje"
		}
	}
}

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" : "SRQ",
				"attrValues" : [
					{
						"attrValue" : "Open",
						"thirdPartyAttrValue" : "In Progress"
					},
					{
						"attrValue" : "Closed",
						"thirdPartyAttrValue" : "Completed"
					}
				]
			},
			{
				"name" : "Status",
				"attrName" : "incident.status.name",
				"thirdPartyAttrName" : "stats",
				"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" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			},
			{
				"name" : "Priority",
				"attrName" : "serviceRequest.priority.name",
				"thirdPartyAttrName" : "severity",
				"entityType" : "SERVICEREQUEST",
				"thirdPartyEntityType" : "SRQ",
				"attrValues" : [
					{
						"attrValue" : "High",
						"thirdPartyAttrValue" : "Max"
					},
					{
						"attrValue" : "Low",
						"thirdPartyAttrValue" : "min"
					}
				]
			}
		]
	},
	"outboundConfig" : {
		"baseNotifier" : {
			"baseURI" : "www.google.com",
			"authType" : "OAUTH2",
			"grantType" : "PASSWORD",
			"userName" : "testUser",
			"apiKey" : "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"accessTokenURL" : "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"
					}
				]
			}
		]
	}
}