Collaboration Integrations

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:

Collaboration	Collaboration
Autotask	JIRA
AWS Support	NetEnrich Ticketing System
BMC Remedy	PMG
CA Service Desk	ServiceNow
Cherwell	Slack
ConnectWise	Solutions Desk
Email Request	Zendesk
Freshservice

Parameters

All fields are mandatory:

Field	Sub-Fields	Data Type	Values	Description
inboundConfig	mapAttributes
	1. name	String	NA	OpsRamp attribute name.
	2. tenantAttrName	String	NA	Third-party attribute name.
	3. entityType	String	ALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK	OpsRamp entity type.
	4. tenantEntityType	String	NA	Third-party entity type.
	5. attrValues attrValue tenantAttrValue	String	NA	Mapping attribute values: OpsRamp mapping attribute value Third-party mapping attribute mapping value
outboundConfig	1. mapAttributes
	1. name	String	NA	OpsRamp attribute name.
	2. tenantAttrName	String	NA	Third-party attribute name.
	3. entityType	String	ALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK	OpsRamp entity type.
	4. tenantEntityType	String	NA	Third-party entity type.
	5. attrValues attrValue tenantAttrValue	String	NA	Mapping attribute values: OpsRamp mapping attribute value Third-party mapping attribute mapping value
	2. notifier
	1. type	String	REST_API, SOAP_API	Notification type.
	2. authType	String	NONE, BASIC, OAUTH2	Authentication type.
	3. grantType	String	CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN	Grant type for notification.
	4. userName	String	NA	Username.Mandatory when authType is BASIC/OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
	5. password	String	NA	PasswordMandatory when authType is BASIC/OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
	6. apiKey	String	NA	API Key.Mandatory if authType is OAUTH2.
	7. apiSecret	String	NA	API Secret.Mandatory if authType is OAUTH2.
	8. accessTokenURI	String	NA	Access 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"
					}
				]
			}
		]
	}
}